@zokugun/xtry

Simple try/catch wrapper returning Result

Getting Started

With node previously installed:

npm install @zokugun/xtry

Basic Example

import { xatry } from '@zokugun/xtry'

const { fails, value, error } = xatry(somePromise);

Advanced Example

import { err, ok, type Result, xatry, xtry } from '@zokugun/xtry'

export type FoobarError = { type: 'FOOBAR'; message: string };

function foobar(): Result<number, FoobarError> {
    const { fails, value, error } = xatry(somePromise);

    if (fails) {
        return err({ type: 'FOOBAR', message: 'The promise has failed...' });
    }

    return ok(value);
}

function main() {
    const result = foobar();

    if (result.fails) {
        console.error(result.error.message);
        exit(1);
    }

    console.log(value);
}

API

type Success<T> = {
    fails: false;
    value: T;
    error: null;
};
type Failure<E> = {
    fails: true;
    value: null;
    error: E;
};
export type Result<T, E> = Success<T> | Failure<E>;
export function xtry<T, E>(func: () => Exclude<T, Promise<unknown>>, handler?: ((error: E) => void)): Result<T, E>;
export async function xatry<T, E>(func: (() => Exclude<T, Promise<unknown>>) | Promise<Exclude<T, Promise<unknown>>>, handler?: ((error: E) => void)): Promise<Result<T, E>>;
export function ok<T>(value: T): Success<T>;
export function err<E>(error: E): Failure<E>;

Donations

Support this project by becoming a financial contributor.

	ko-fi.com/daiyam
	liberapay.com/daiyam/donate
	paypal.me/daiyam99

License

Copyright © 2025-present Baptiste Augrain

Licensed under the MIT license.