2.7.1 โ€ข Published 10 months ago

@sapphire/result v2.7.1

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.0-next.09afdaab

10 months ago

2.7.0-next.4b7c3e6c

10 months ago

2.7.0

10 months ago

2.7.1

10 months ago

2.7.2-next.9b2d985c

10 months ago

2.7.0-next.0cb1b7f1

10 months ago

2.7.0-next.ba915f93

10 months ago

2.7.2-next.79db3048

10 months ago

2.7.0-next.d8701971

10 months ago

2.7.0-next.bb6c8891

10 months ago

2.7.0-next.143375f7

10 months ago

2.7.0-next.78b93032

10 months ago

2.7.2-next.624d18f9

10 months ago

2.7.2-next.24be195f

10 months ago

2.7.2-next.8490b4d9

10 months ago

2.6.7-next.72e50e85

10 months ago

2.6.7-next.0dce7d63

10 months ago

2.6.7-next.d8c5d05d

10 months ago

2.6.7-next.5ac3f246

10 months ago

2.6.7-next.a6c8ccda

10 months ago

2.6.7-next.78c5a5bb

10 months ago

2.6.7-next.403a3afe

11 months ago

2.6.7-next.1e7d2dec

11 months ago

2.6.7-next.809c41ce

11 months ago

2.6.7-next.acf54294

11 months ago

2.6.7-next.caddeb87

11 months ago

2.6.7-next.70feaf69

11 months ago

2.6.7-next.74c9ef24

11 months ago

2.6.7-next.19790b8e

12 months ago

2.6.7-next.a133f01a

12 months ago

2.6.7-next.574c09c3

12 months ago

2.6.7-next.8627eb32

12 months ago

2.6.7-next.b913810f

12 months ago

2.6.7-next.86dab688

12 months ago

2.6.7-next.fc35dd86

12 months ago

2.6.7-next.b97b30cd

12 months ago

2.6.7-next.6100b95e

12 months ago

2.6.7-next.855b323f

12 months ago

2.6.7-next.63feeab8

12 months ago

2.6.6

2 years ago

2.6.5

2 years ago

2.6.3

2 years ago

2.6.4

2 years ago

2.6.1

2 years ago

2.6.2

2 years ago

2.6.0

3 years ago

2.5.0

3 years ago

2.4.1

3 years ago

2.4.0

3 years ago

2.0.1

3 years ago

2.0.0

3 years ago

2.3.0

3 years ago

2.3.2

3 years ago

2.3.1

3 years ago

2.3.3

3 years ago

2.2.0

3 years ago

2.1.1

3 years ago

1.1.1

3 years ago

1.1.0

3 years ago

1.0.0

4 years ago