o-promise

Open Promise 👐

Micro tool for creating OpenPromise likes Deferred (with AbortController support).

npm i --save o-promise

Usage

import {createOpenPromise} from 'o-promise';

// 1. Tuple
const [promise, resolve, reject] = createOpenPromise<string>();

// 2. or Deferred
const {promise, resolve, reject} = createOpenPromise<number>();

// 3. With executer + return
const open = createOpenPromise(() => {
	return '...';
});

open.state; // pending
open.reject('canceled'); // `executer` — won't be called
open.state; // rejected

// 4. With executer + promise
const open = createOpenPromise(() => {
	// for example
	return fetch('...');
});

// 5. With executer + resolvers + controller
const open = createOpenPromise((resolve, reject, controller) => {
	// Your Logic
});

Support AbortController and AbortSignal

Dependent OpenPromise on AbortController

const parentController = new AbortController();
const open = createOpenPromise<number>(parentController); // <- AbortController

open.promise.catch(reason => {
	console.info('OpenPromise canceled by parentController:', reason);
});

parentController.abort('canceled'); // ℹ️: open.controller === parentController;

Dependent OpenPromise on AbortSignal

const parentController = new AbortController();
const open = createOpenPromise<number>(parentController.signal); // <- AbortSignal

open.promise.catch(reason => {
	console.info('OpenPromise canceled by parentSignal:', reason);
});

parentController.abort('canceled'); // ⚠️: open.controller !== parentController;

Example: Open "fetch"

import {createOpenPromise} from 'o-promise';

const openFetch = createOpenPromise((_, __, controller) => {
	return fetch('...', {signal: controller.signal});
});

// Reject
openFetch.reject('canceled');

// Or `AbortController#abort`
openFetch.controller.abort('canceled');

100% code & types coverage ;]

Changelog

v1.4.0

• Support creation OpenPromise with AbortController or AbortSignal
• Fixed types to allow resolving with a Promise value