npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ts-box

v0.3.0

Published

Put exceptions into boxes

Downloads

8

Readme

📦 ts-box

Put exceptions into boxes.

In JavaScript and therefor in TypeScript any function can throw anything at any time. This makes exception handling hard. ts-box is a workaround which puts function return values into boxes (like a maybe monad) and forces users to check for the error at the type level before the actual value can be accessed.

Install

npm install ts-box

Usage

Use boxify() to boxify existing functions

import {boxify} from "ts-box";

// Make a version of fetch that never throws exceptions
const boxedFetch = boxify(fetch);

async function main() {
    const box = await boxedFetch("/api");

    if (!box.ok) {
        console.log("Fetch failed", box.error);
        return;
    }

    // The value can be accessed only when the error is handled
    console.log("Fetch ok!", box.value.status);
}

Use runBox() to immediately execute a function with boxing

import {runBox} from "ts-box";
const jsonBox = runBox(() => box.value.json());
if (jsonBox.ok) {
    // jsonBox.value...
}

Use boxifyObject() to boxify object of functions

import {boxifyObject} from "ts-box";
import Axiox from "axios";

const BoxifiedAxios = boxifyObject(Axios);

The return type

The return type of a boxified function is always a discriminated union ResultBox with a common ok singleton property as the discriminant which can be used to narrow the type to the value or error.

type ResultBox<T> = {ok: true; value: T} | {ok: false; error: any};

Read more about the TypeScript discriminated unions here:

https://www.typescriptlang.org/docs/handbook/advanced-types.html#discriminated-unions