Package Exports
- cancelable-promise
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cancelable-promise) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
cancelable-promise
A simple Cancelable Promise.
This package is based on ES Promise.
FYI, you can cancel a fetch request with AbortController & AbortSignal.
Table of Contents
Install
npm install --save cancelable-promiseUsage
CancelablePromise acts like an ES Promise: you can use Promise.all, Promise.race with your CancelablePromise for example. The only difference is you'll have a cancel method on your promise to cancel future execution of then or catch functions. CancelablePromise will also cancel all callbacks attached to new promises returned by then/catch.
A callback passed to finally will be always executed.
Basic example
import { cancelable, CancelablePromise } from 'cancelable-promise';
const promises = [
cancelable(new Promise((resolve) => setTimeout(resolve, 1))),
new CancelablePromise((resolve) => setTimeout(resolve, 1)),
];
for (const promise of promises) {
promise.then(() => console.log('not logged'));
promise.cancel();
}
// Nothing will be loggedNodeJS
const { cancelable } = require('cancelable-promise');
cancelable(new Promise((resolve) => resolve('ok')));Browser
<script src="https://unpkg.com/cancelable-promise@3.0.0/dist/CancelablePromise.min.js"></script>
<script>
const { cancelable } = window.CancelablePromise;
cancelable(new Promise((resolve) => resolve('ok')));
</script>API
cancelable
import { cancelable } from 'cancelable-promise';
/**
* @param {Promise} arg - a native Promise
* @returns {CancelablePromise}
*/
cancelable(
new Promise((resolve) => {
resolve('ok');
})
);CancelablePromise
import CancelablePromise from 'cancelable-promise';
/**
* @param {(resolve, reject) => void} arg - a promise executor
* @returns {CancelablePromise}
*/
new CancelablePromise((resolve, reject) => {
resolve('ok');
});CancelablePromise.cancel
/**
* @returns {void}
*/
cancelablePromise.cancel();CancelablePromise.isCanceled
/**
* @returns {boolean}
*/
cancelablePromise.isCanceled();Static methods
Same as Promise static methods.
import CancelablePromise from 'cancelable-promise';
CancelablePromise.resolve();
CancelablePromise.reject();
CancelablePromise.all([promise1, promise2]);
CancelablePromise.race([promise1, promise2]);
CancelablePromise.allSettled([promise1, promise2]);You can still use the native Promise API and wrap your promise:
import { cancelable } from 'cancelable-promise';
cancelable(Promise.all([promise1, promise2]));
cancelable(Promise.race([promise1, promise2]));
cancelable(Promise.allSettled([promise1, promise2]));Scripts
Build
Run babel
npm run buildTests
Run eslint and jest
npm testEnd-to-end tests
Run cypress
npm run cypressContributing
Feel free to dive in! Open an issue or submit PRs.
Contributors
This project exists thanks to all the people who contribute.
Code of conduct
Contributor Covenant Code of Conduct.
License
MIT License © Alkemics