rustyresult

This package (almost) reimplements std::Result from Rust in TypeScript

If you are not familiar with it yet, I also recommend reading the official docs for std::Result

Installation

NPM

npm install rustyresult

Yarn

yarn add rustyresult

Example usage

// YourAxiosWrapper.ts
import { Result } from "rustyresult";
import axios from 'axios';

export class YourAxiosWrapper {
    static async get<T>(url: string): Promise<Result<T, Error>> {
        try {
            const response = await axios.get(url);
            return Result.Ok(response);
        } catch (error) {
            return error instanceof Error ? Result.Err(error) : Result.Err(new Error("Unexpected error"));
        }
    }
}

// UserApi.ts
import { YourAxiosWrapper } from "YourAxiosWrapper";
class UserApi {
    async getUser(userId: string) {
        const user = await YourAxiosWrapper.get("https://someapi.com/user/" + userId);
        // Consumer is now **forced** to deal with the possibility of an error unlike when an error is thrown 
        // For example:
        return user.unwrapOr(defaultUser);
    }
}