npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

functional-try

v3.0.0

Published

Error handling wrapper for cleaner use of strict type checking in TypeScript

Downloads

25

Readme

functional-try

Error handling wrapper for cleaner use of strict type checking in TypeScript

This library is intended to replace await-to-js in projects using TypeScript with strict settings.

Install

npm i functional-try

Motivation

I use await-to-js quite extensively in TypeScript projects, with a pattern similar to:

const [err, res] = await to(someAsyncFunction(params));

if (err) {
    handleError(err);
    return;
}

doSomethingWithRes(res);

But this doesn't work well with strict typing. Even though the return type of to indicates that err and res should be mutually exclusive, TypeScript still thinks res is possibly undefined due to the deconstruction severing the logical connection between the two.

This can be avoided by just not deconstucting:

const asyncRes = await to(someAsyncFunction(params));

if (asyncRes[0]) {
    handleError(asyncRes[0]);
    return;
}

handleSuccess(asyncRes[1]);

In this case TypeScript knows that by the time handleSuccess is called asyncRes[1] has a value because asyncRes[0] doesn't, avoiding the type error. But this doesn't result in very readable code.

This package functions nearly identical to await-to-js, just returning an object instead of a tuple, making usage without deconstruction cleaner.

Usage

Import

import { trySync, tryAsync } from 'functional-try';

Synchronous

trySync takes a function and the parameters to invoke it with. It will synchronously call the function, automatically catch any errors, and return an object containing the function's result or caught error.

const parsedJson = trySync(JSON.parse, fileString);

if (!parsedJson.success) {
    console.log('Error parsing JSON', parsedJson.error);
    return;
}

handleSuccess(parsedJson.value);

Asynchronous

tryAsync takes a promise and returns another promise that resolves to an object containing the first's result or caught error.

const asyncRes = await tryAsync(someAsyncFunction(params));

if (!asyncRes.success) {
    handleError(asyncRes.error);
    return;
}

handleSuccess(apiRes.value);