Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@susisu/promise-utils

susisu638MIT0.2.0TypeScript support: included

Promise utilities

readme

@susisu/promise-utils

CI

Promise utilities

# npm
npm i @susisu/promise-utils
# yarn
yarn add @susisu/promise-utils
# pnpm
pnpm add @susisu/promise-utils

Usage

triplet

Creates a triplet of a promise and its resolve and reject functions.

import { triplet } from "@susisu/promise-utils";

const [promise, resolve, reject] = triplet<number>();

resolve(42);

promise.then(res => {
  console.log(res); // -> 42
});

attachActions

Attaches cancellable actions to a promise.

import { triplet, attachActions } from "@susisu/promise-utils";

const [promise, resolve, reject] = triplet<number>();

const [cancel] = attachActions(
  promise,
  res => { console.log(res); },
  err => { console.log(err); }
);

cancel();

resolve(42); // no output

License

MIT License

Author

Susisu (GitHub, Twitter)

changelog

0.2.0 (2024-02-29)

  • The package is now ESM/CJS dual

0.1.2 (2022-04-17)

  • Add source files in the distribution package
    • Now users can refer to the source files in node_modules via source maps

0.1.1 (2021-12-02)

  • Upgrade devDependencies

0.1.0 (2020-04-12)

  • First release