p-cancelable

Create a promise that can be canceled

Useful for animation, loading resources, long-running async computations, async iteration, etc.

If you target Node.js 16 or later, this package is less useful and you should probably use AbortController instead.

Install

1npm install p-cancelable

Usage

1import PCancelable from 'p-cancelable';
2
3const cancelablePromise = new PCancelable((resolve, reject, onCancel) => {
4	const worker = new SomeLongRunningOperation();
5
6	onCancel(() => {
7		worker.close();
8	});
9
10	worker.on('finish', resolve);
11	worker.on('error', reject);
12});
13
14// Cancel the operation after 10 seconds
15setTimeout(() => {
16	cancelablePromise.cancel('Unicorn has changed its color');
17}, 10000);
18
19try {
20	console.log('Operation finished successfully:', await cancelablePromise);
21} catch (error) {
22	if (cancelablePromise.isCanceled) {
23		// Handle the cancelation here
24		console.log('Operation was canceled');
25		return;
26	}
27
28	throw error;
29}

API

new PCancelable(executor)

Same as the Promise constructor, but with an appended onCancel parameter in executor.

Cancelling will reject the promise with CancelError. To avoid that, set onCancel.shouldReject to false.

1import PCancelable from 'p-cancelable';
2
3const cancelablePromise = new PCancelable((resolve, reject, onCancel) => {
4	const job = new Job();
5
6	onCancel.shouldReject = false;
7	onCancel(() => {
8		job.stop();
9	});
10
11	job.on('finish', resolve);
12});
13
14cancelablePromise.cancel(); // Doesn't throw an error

PCancelable is a subclass of Promise.

onCanceled(fn)

Type: Function

Accepts a function that is called when the promise is canceled.

You're not required to call this function. You can call this function multiple times to add multiple cancel handlers.

PCancelable#cancel(reason?)

Type: Function

Cancel the promise and optionally provide a reason.

The cancellation is synchronous. Calling it after the promise has settled or multiple times does nothing.

PCancelable#isCanceled

Type: boolean

Whether the promise is canceled.

PCancelable.fn(fn)

Convenience method to make your promise-returning or async function cancelable.

The function you specify will have onCancel appended to its parameters.

1import PCancelable from 'p-cancelable';
2
3const fn = PCancelable.fn((input, onCancel) => {
4	const job = new Job();
5
6	onCancel(() => {
7		job.cleanup();
8	});
9
10	return job.start(); //=> Promise
11});
12
13const cancelablePromise = fn('input'); //=> PCancelable
14
15// …
16
17cancelablePromise.cancel();

CancelError

Type: Error

Rejection reason when .cancel() is called.

It includes a .isCanceled property for convenience.

FAQ

Cancelable vs. Cancellable

In American English, the verb cancel is usually inflected canceled and canceling—with one l. Both a browser API and the Cancelable Promises proposal use this spelling.

What about the official Cancelable Promises proposal?

It's still an early draft and I don't really like its current direction. It complicates everything and will require deep changes in the ecosystem to adapt to it. And the way you have to use cancel tokens is verbose and convoluted. I much prefer the more pragmatic and less invasive approach in this module. The proposal was withdrawn.

p-cancelable for enterprise

Available as part of the Tidelift Subscription.

The maintainers of p-cancelable and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

Related

• p-progress - Create a promise that reports progress
• p-lazy - Create a lazy promise that defers execution until .then() or .catch() is called
• More…