https://github.com/kjartanhr/eav

Simple errors-as-values for TypeScript.
https://github.com/kjartanhr/eav

Last synced: 12 days ago
JSON representation

Simple errors-as-values for TypeScript.

• Host: GitHub
• URL: https://github.com/kjartanhr/eav
• Owner: kjartanhr
• License: mit
• Created: 2024-05-18T15:58:56.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-21T22:17:52.000Z (6 months ago)
• Last Synced: 2024-09-24T09:17:37.376Z (about 2 months ago)
• Language: TypeScript
• Homepage:
• Size: 49.8 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eav - errors as values

The pattern of exceptions in languages like JavaScript (+ TypeScript), Java, C#, etc. can create confusing control flow that's unpredictable and hard to work with.

This package aims to help JS and TS developers "unwrap" functions that throw errors into a simple combination of `res` and `err` variables that can then be handled accordingly with guard clauses.

Below is an example:

```ts

import { unwrapAsync as unwrap } from "@spaugur/eav";

// unwrap the value and exception

const { res, err } = await unwrap(async () => {

    throw new Error('Something bad happened.');

    // we can pretend this return is sometimes reachable...

    return {test: 'data'};

});

// handle any errors

if (err || !res) {

    if (err instanceof Error) {

        console.log('Error!', err.message);

        return;

    }

    console.log(err);

    return;

}

// consume the value

console.log(res);

```

The above could easily be adapted to deal with the errors that `fetch` might throw, something almost every JS/TS developer has to deal with at some point.

We use this package internally at [Spaugur](https://spaugur.com/).

You could also totally copy the source code into your own projects. It's tiny!

(c) 2024 Kjartan Hrafnkelsson, under MIT license.