simple-abortable-promise  

A Simple Implementation of Abortable Promise

Overview

This library provides a deadly simple implementation of making Promise abortable.

That is, an AbortablePromise is a Promise with the abitlity to be aborted.

When an AbortablePromise is aborted, it will reject with an AbortError.

How to install?

``bash
npm install simple-abortable-promise
`

How to use?

$3

There are 2 ways to create an AbortablePromise:

#### Constructor

`typescript
const abortablePromise = new AbortablePromise((resolve, reject, abortSignal) => {
// ...
});
`

#### Create from an existing Promise

`typescript
const abortablePromise = AbortablePromise.from(promise);
`

$3

`typescript
// Abort with default reason - Aborted
abortablePromise.abort();

// Abort with custom reason
abortablePromise.abort('I abort it');
`

Receipes

$3

`typescript
const loadData = (id: number) => {
retrun new AbortablePromise((resolve, reject, abortSignal) => {
fetch(url, { signal: abortSignal })
.then(response => response.json())
.then(parseJsonToData)
.then(resolve)
.catch(reject);
});
}

const abortablePromise = loadData(id);
abortablePromise.abort();
`

$3

`typescript
const abortablePromise = new AbortablePromise((resolve, reject, abortSignal) => {
abortSignal.addEventListener('abort', () => {
// Do something
});
// ...
});
``

More

More background explain is available on my blog.