# make-cancel-promise

> Make your promises cancelable

Latest version **1.0.2** (published 2020-09-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install make-cancel-promise
pnpm add make-cancel-promise
yarn add make-cancel-promise
bun add make-cancel-promise
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-09-10 |
| First published | 2020-09-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | switchwebdev@gmail.com |
| Maintainers | sw1tchdev |
| Keywords | promise, cancel |

## Links

- npm: https://www.npmjs.com/package/make-cancel-promise
- Repository: https://github.com/sw1tchdev/make-cancel-promise
- Homepage: https://github.com/sw1tchdev/make-cancel-promise#readme
- Issues: https://github.com/sw1tchdev/make-cancel-promise/issues
- npm.io page: https://npm.io/package/make-cancel-promise

## Alternatives

- [promise-throttle](https://npm.io/package/promise-throttle.md) — 44.2K weekly downloads
- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2020-09-10
- 1.0.1 — 2020-09-09
- 1.0.0 — 2020-09-09

## README

# make-cancel-promise ![tests](https://github.com/sw1tchdev/make-cancel-promise/workflows/Tests/badge.svg) [![codecov](https://codecov.io/gh/sw1tchdev/make-cancel-promise/branch/master/graph/badge.svg)](https://codecov.io/gh/sw1tchdev/make-cancel-promise)
Make your promises cancelable

## Install
NPM:
```
npm install make-cancel-promise
```

## Features
1. Working with native, polyfills, shim'ed Promises
1. Isomorphic library
1. Zero dependencies
1. Typescript declarations

## Usage example
Basic usage
```javascript
import {
    makeCancelPromise, 
    CancelablePromiseError,
    cancelPromise
} from 'make-cancel-promise';

const cancelablePromise = makeCancelPromise(
    (resolve, reject, onCancel) => {
        const timeoutResolve = setTimeout(() => {
            resolve('resolve');
        }, 10);
        const timeoutReject = setTimeout(() => {
            reject('reject');
        }, 20);
        onCancel(() => {
            clearTimeout(timeoutResolve);
            clearTimeout(timeoutReject);
        });
});

cancelablePromise.catch((e) => {
    if(e instanceof CancelablePromiseError){
        console.log('Promise has been canceled');
    }       
});

cancelPromise(cancelablePromise).catch((e) => {
  console.error(e);
});
```

Cancel with ClearSymbol
```javascript
import {
    makeCancelPromise, 
    CancelablePromiseError, 
    clearSymbol
} from 'make-cancel-promise';

const cancelablePromise = makeCancelPromise(
    (resolve, reject, onCancel) => {
        const timeoutResolve = setTimeout(() => {
            resolve('resolve');
        }, 10);
        const timeoutReject = setTimeout(() => {
            reject('reject');
        }, 20);
        onCancel(async () => {
            clearTimeout(timeoutResolve);
            clearTimeout(timeoutReject);
            });
});

cancelablePromise.catch((e) => {
    if(e instanceof CancelablePromiseError){
        console.log('Promise has been canceled');
    }       
});

cancelablePromise[clearSymbol]().catch((e) => {
  console.error(e);
});
```

Cancel with ClearSymbol without rejecting
```javascript
import {
    makeCancelPromise, 
    CancelablePromiseError, 
    clearSymbol
} from 'make-cancel-promise';

const cancelablePromise = makeCancelPromise(
    (resolve, reject, onCancel) => {
        const timeoutResolve = setTimeout(() => {
            resolve('resolve');
        }, 10);
        const timeoutReject = setTimeout(() => {
            reject('reject');
        }, 20);
        onCancel(async () => {
            clearTimeout(timeoutResolve);
            clearTimeout(timeoutReject);
        });
});

cancelablePromise.catch((e) => {
    if(e instanceof CancelablePromiseError){
        console.log('Promise has been canceled');
    }       
});

// passing false to "clearSymbol" function will be cancel promise without rejecting
cancelablePromise[clearSymbol](false).catch((e) => {
  console.error(e);
});
```

---
_Source: https://npm.io/package/make-cancel-promise · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
