2.7.2 โ€ข Published 10 months ago

@sapphire/result v2.7.2

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

Sapphire Logo

@sapphire/result

Result wrappers for function try-catch code blocks

GitHub codecov npm bundle size npm

Description

When having many try-catch blocks after one another, or multiple try-catch blocks nested in one another then code can become very chaotic very quickly. To alleviate that issue we have made the @sapphire/result which offers simple wrappers around such code. This code has been branched off of @sapphire/framework into its own package after we saw great success with the code there. Furthermore we also have wrappers for other arbitrary values in isMaybe, isSome, and isNone.

The code in this package has been greatly inspired by lexure from 1Computer1.

Features

  • Written in TypeScript
  • Bundled with esbuild so it can be used in NodeJS and browsers
  • Offers CommonJS, ESM and UMD bundles
  • Fully tested

Installation

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @sapphire/result

Usage

Note: While this section uses require, the imports match 1:1 with ESM imports. For example const { from } = require('@sapphire/result') equals import { from } from '@sapphire/result'.

Wrapping synchronous try-catch blocks

Old code without from:

try {
	const returnCode = someFunctionThatMightThrow();

	return returnCode;
} catch (error) {
	// Handle the error, for example let it bubble up:
	throw new Error(error);
}

New Code with from:

const { from, isErr } = require('@sapphire/result');

const returnCode = from(() => someFunctionThatMightThrow());

if (isErr(returnCode)) {
	throw new Error(returnCode.error);
}

return returnCode.value;

Wrapping asynchronous try-catch blocks

Old code without fromAsync:

try {
	const returnCode = await someFunctionThatReturnsAPromiseAndMightReject();

	return returnCode;
} catch (error) {
	// Handle the error, for example let it bubble up:
	throw new Error(error);
}

New Code with fromAsync:

const { fromAsync, isErr } = require('@sapphire/result');

const returnCode = await fromAsync(async () => someFunctionThatReturnsAPromiseAndMightReject());

if (isErr(returnCode)) {
	throw new Error(returnCode.error);
}

return returnCode.value;

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate WithAddress
Open CollectiveClick Here
Ko-fiClick Here
PatreonClick Here
PayPalClick Here

Contributors โœจ

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

2.7.2

1 year ago

2.7.3-next.2237f1c6

12 months ago

2.7.3-next.d7167620

11 months ago

2.7.3-next.e79994f1

12 months ago

2.7.3-next.a41a8cc4

11 months ago

2.7.3-next.da07d098

10 months ago

2.7.3-next.3b2a6fae

11 months ago

2.7.3-next.7dc50c72

11 months ago

2.7.3-next.44446bab

11 months ago

2.7.3-next.893fe544

12 months ago

2.7.3-next.a8df7770

12 months ago

2.7.3-next.c1d407e3

11 months ago

2.7.3-next.fb5ad246

11 months ago

2.7.3-next.beeba83b

12 months ago

2.7.3-next.2acce636

12 months ago

2.7.3-next.bab0bd45

11 months ago

2.7.3-next.da56be56

10 months ago

2.7.3-next.41417ed2

12 months ago

2.7.3-next.cfb8940c

12 months ago

2.7.3-next.4bc55911

12 months ago

2.7.3-next.9eadc390

10 months ago

2.7.3-next.df204ea0

11 months ago

2.7.3-next.28c42f39

10 months ago

2.7.3-next.11e9646b

10 months ago

2.7.0

1 year ago

2.7.1

1 year ago

2.6.6

2 years ago

2.6.5

2 years ago

2.6.3

3 years ago

2.6.4

3 years ago

2.6.1

3 years ago

2.6.2

3 years ago

2.6.0

3 years ago

2.5.0

4 years ago

2.4.1

4 years ago

2.4.0

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

2.3.0

4 years ago

2.3.2

4 years ago

2.3.1

4 years ago

2.3.3

4 years ago

2.2.0

4 years ago

2.1.1

4 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.0.0

4 years ago