@sapphire/result

@sapphire/result

Result wrappers for function try-catch code blocks

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

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jeroen Claassens 💻 🚇 📆 📖 ⚠️	Antonio Román 💻 📆 👀 ⚠️	Gryffon Bellish 💻 👀 ⚠️	Vlad Frangu 💻 🐛 👀 📓 ⚠️	Stitch07 💻 📆 ⚠️	depfu[bot] 🚧	allcontributors[bot] 📖
Tyler J Russell 📖	Ivan Lieder 💻 🐛	Hezekiah Hendry 💻	Vetlix 💻	Ethan Mitchell 📖	Elliot 💻	Jurien Hamaker 💻
Charalampos Fanoulis 📖	dependabot[bot] 🚧	Kaname 💻	nandhagk 🐛	megatank58 💻	UndiedGamer 💻	Lioness100 📖 💻
David 💻	renovate[bot] 🚧	WhiteSource Renovate 🚧	FC 💻	Jérémy de Saint Denis 💻	MrCube 💻	bitomic 💻
c43721 💻

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