Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

p-cancelable

Package Overview
Dependencies
0
Maintainers
1
Versions
15
Issues
File Explorer

Advanced tools

p-cancelable

Create a promise that can be canceled

    4.0.1latest

Version published
Maintainers
1
Weekly downloads
16,721,597
increased by1.86%

Weekly downloads

Changelog

Source

  • Fix: Ensure the state is only changed if the promise was pending (#34) 31fbf8f

https://github.com/sindresorhus/p-cancelable/compare/v4.0.0...v4.0.1

Readme

Source

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

npm install p-cancelable

Usage

import PCancelable from 'p-cancelable'; const cancelablePromise = new PCancelable((resolve, reject, onCancel) => { const worker = new SomeLongRunningOperation(); onCancel(() => { worker.close(); }); worker.on('finish', resolve); worker.on('error', reject); }); // Cancel the operation after 10 seconds setTimeout(() => { cancelablePromise.cancel('Unicorn has changed its color'); }, 10000); try { console.log('Operation finished successfully:', await cancelablePromise); } catch (error) { if (cancelablePromise.isCanceled) { // Handle the cancelation here console.log('Operation was canceled'); return; } throw error; }

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.

import PCancelable from 'p-cancelable'; const cancelablePromise = new PCancelable((resolve, reject, onCancel) => { const job = new Job(); onCancel.shouldReject = false; onCancel(() => { job.stop(); }); job.on('finish', resolve); }); cancelablePromise.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.

import PCancelable from 'p-cancelable'; const fn = PCancelable.fn((input, onCancel) => { const job = new Job(); onCancel(() => { job.cleanup(); }); return job.start(); //=> Promise }); const cancelablePromise = fn('input'); //=> PCancelable // … cancelablePromise.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.

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

Keywords

FAQs

What is p-cancelable?

Create a promise that can be canceled

Is p-cancelable popular?

The npm package p-cancelable receives a total of 14,609,670 weekly downloads. As such, p-cancelable popularity was classified as popular.

Is p-cancelable well maintained?

We found that p-cancelable demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 19 Jul 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc