promise-abortable


Concept

abort != reject

Features

- Abort in promise
- Abort in promise chain
- Abort for nesting promise
- Return promise after abort

Use Cases

- Cancel request when component hide, unmount or destory
- Cancel long-running async operation
- Return promise with abort for common request function

Browser Support

Any browser that supports Promise.

!Chrome | !Firefox | !Safari | !Opera | !Edge |
--- | --- | --- | --- | --- |
33 ✔ | 29 ✔ | 8 ✔ | 20 ✔ | 12 ✔ |

- Use Babel for lower versions
- Or include script iife.es3.js below
- But I think bluebird 3 is a better choice

Install

``bash
$ npm install promise-abortable
`

`javascript
import AbortablePromise from "promise-abortable";
`

The IIFE build is also available on unpkg:

`html



`

Usage

`javascript
// 1. Instantiate
const promise = new AbortablePromise((resolve, reject, signal) => {
// 2. Set abort handler
signal.onabort = reason => {
// 4. Abort won't reject, but you can reject manually
};
});
// 3. Invoke signal.onabort(reason)
promise.abort(reason);
`

Pseudo code

> See full examples here.

$3

`javascript
const promise = new AbortablePromise(...);
// or: const promise = AbortablePromise.resolve(...);
// or: const promise = AbortablePromise.reject(...);
// or: const promise = AbortablePromise.all([...]);
// or: const promise = AbortablePromise.race([...]);
promise.abort();
`




$3

`javascript
const promise = new AbortablePromise(...).then(...).catch(...);
promise.abort();
`




$3

`javascript
const promise = AbortablePromise.resolve(...).then(value => {
return new AbortablePromise(...);
});
promise.abort();
`




$3

`javascript
const promise = new AbortablePromise(...);
promise.abort().then(...).catch(...);
`




$3

`javascript
const promise = new AbortablePromise(...);
(async () => {
try { await promise; } catch (error) {...}
})();
promise.abort();
``