@sapphire/result
TypeScript icon, indicating that this package has built-in type declarations

2.6.6 • Public • Published

Sapphire Logo

@sapphire/result

A TypeScript port of Nightly Rust's Result and Option structs

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 two structures based on Rust's Result<T, E> and Option<T> with full Nightly coverage and extra convenience methods. This code has been branched off of @sapphire/framework into its own package after we saw great success with the code there.

Features

  • Written in TypeScript
  • Bundled with esbuild so it can be used in NodeJS and browsers
  • Offers CommonJS, ESM and UMD bundles
  • Full feature parity with Nightly Rust's Result<T, E> and Option<T>
  • 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 1: While this section uses require, the imports match 1:1 with ESM imports. For example const { Result } = require('@sapphire/result') equals import { Result } from '@sapphire/result'.

Note 2: For more thorough examples check out the generated documentation on our website here

Wrapping synchronous try-catch blocks

Old code without Result.from:

try {
	const returnCode = someFunctionThatMightThrow();

	return returnCode;
} catch (error) {
	// Handle the error:
	console.error(error);
	return null;
}

New Code with Result.from:

const { Result } = require('@sapphire/result');

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

return returnCode.unwrapOrElse((error) => {
	console.error(error);
	return null;
});

Wrapping asynchronous try-catch blocks

Old code without Result.fromAsync:

try {
	const returnCode = await someFunctionThatReturnsAPromiseAndMightReject();

	return returnCode;
} catch (error) {
	// Handle the error:
	console.error(error);
	return null;
}

New Code with Result.fromAsync:

const { Result } = require('@sapphire/result');

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

return returnCode.unwrapOrElse((error) => {
	console.error(error);
	return null;
});

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 With Address
Open Collective Click Here
Ko-fi Click Here
Patreon Click Here
PayPal Click Here

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Sapphire!

Package Sidebar

Install

npm i @sapphire/result

Weekly Downloads

6,266

Version

2.6.6

License

MIT

Unpacked Size

298 kB

Total Files

11

Last publish

Collaborators

  • favna
  • kyranet
  • vladfrangu