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

cancellation-wrapper

v1.0.1

Published

Wraps your api methods and functions and make possible to pass a cancellation token for promises

Downloads

6

Readme

Small wrapper for accepting cancellation tokens

Wraps your api methods and functions and make possible to pass a cancellable tokens.

Examples:

  1. If your function returns a PromiseLike object and you need to cancel it by passing cancellation token as a last argument, than you can use wrapFn function.
import { wrapFn, CancellationToken } from "wrapper";

const yourFn = (a, b) => new Promise(res => {
    res(a + b);
});

const cancellableYourFn = wrapFn(yourFn);
const token = new CancellationToken();
const result = cancellableYourFn(1, 2, token).then(
    res => res + 1,
    err => 0
).then(
    res => console.log(res) // 0 will be in console
);

// in a few moments you need to abort your action
token.cancel();
  1. If you don't want to mess up with every function and you have some API obejct with list of methods that returns a PromiseLike object and you need to cancel it by passing cancellation token as a last argument, than you can use wrap function.
import { wrap, CancellationToken } from "wrapper";

const yourApi = {
    add: (a, b) => new Promise(res => {
        res(a + b);
    }),
    multiply: (a, b) => new Promise(res => {
        res(a * b);
    }),
    power: (a, b) => new Promise(res => {
        res(a ** b);
    })
}

const cancellableYourApi = wrap(yourApi);
const token = new CancellationToken();
const result = cancellableYourApi.multiply(1, 2, token).catch(
    err => 0
).then(
    res => console.log(res) // 0 will be in console
);

// in a few moments you need to abort your action
token.cancel();

For Node.js you can use npm package. You should install it:

    npm i cancellation-wrapper

and import it in your file:

const { wrapFn, CancellationToken } = require("wrapper");