# axios-cancel

> Simplify cancellation of http requests when using the awesome axios library

Latest version **0.2.2** (published 2016-12-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install axios-cancel
pnpm add axios-cancel
yarn add axios-cancel
bun add axios-cancel
```

## Health

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

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

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2016-12-17 |
| First published | 2016-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/axios-cancel) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 52 |
| Author | Thaer Abbas |
| Maintainers | thaerlabs |
| Keywords | axios, http, cancel, promise |

## Links

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

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.2.2 (latest) — 2016-12-17
- 0.2.1 — 2016-12-15
- 0.2.0 — 2016-12-15
- 0.1.0 — 2016-12-15

## README

# axios-cancel

[![travis build](https://img.shields.io/travis/thaerlabs/axios-cancel/master.svg?style=flat-square)](https://travis-ci.org/thaerlabs/axios-cancel)

Simplify cancellation of http requests when using the awesome [axios](https://github.com/mzabriskie/axios) library

## Installation

Using npm:

`npm install axios-cancel --save`

## Getting started

`axios-cancel` simplifies the interface of the [Cancel](https://github.com/mzabriskie/axios#cancellation) api introducted in axios v1.5, 
which is based on the [cancelable promises proposal](https://github.com/tc39/proposal-cancelable-promises)

```javascript
import axios from 'axios';
import axiosCancel from 'axios-cancel';

axiosCancel(axios, {
  debug: false // default
});

...

// Single request cancellation
const requestId = 'my_sample_request';
const promise = axios.get(url, {
  requestId: requestId
})
  .then((res) => {
    console.log('resolved');
  }).catch((thrown) => {
    if (axios.isCancel(thrown)) {
      console.log('request cancelled');
    } else {
      console.log('some other reason');
    }
  });

axios.cancel(requestId);
// aborts the HTTP request and logs `request cancelled`

```

## Examples

Multiple subsequent requests with same `requestId`

```javascript
...

const requestId = 'my_sample_request';
const promise1 = axios.get(url, {
  requestId: requestId
})
  .then((res) => {
    console.log('resolved promise 1');
  }).catch((thrown) => {
    if (axios.isCancel(thrown)) {
      console.log('request 1 cancelled');
    } else {
      console.log('some other reason');
    }
  });

// another request with same `requestId`, before `promise1` resolution
const promise2 = axios.get(url, {
  requestId: requestId
})
  .then((res) => {
    console.log('resolved promise 2');
  }).catch((thrown) => {
    if (axios.isCancel(thrown)) {
      console.log('request 2 cancelled');
    } else {
      console.log('some other reason');
    }
  });

// aborts the first HTTP request, and cancels the first promise 
// logs `request 1 cancelled`
// logs `resolved promise 2`
```

Multiple requests with different `requestId`, cancell all
```javascript
...

const requestId1 = 'my_sample_request_1';
const promise1 = axios.get(url, {
  requestId: requestId1
})
  .then((res) => {
    console.log('resolved promise 1');
  }).catch((thrown) => {
    if (axios.isCancel(thrown)) {
      console.log('request 1 cancelled');
    } else {
      console.log('some other reason');
    }
  });

const requestId2 = 'my_sample_request_2';
const promise2 = axios.get(url, {
  requestId: requestId2
})
  .then((res) => {
    console.log('resolved promise 1');
  }).catch((thrown) => {
    if (axios.isCancel(thrown)) {
      console.log('request 2 cancelled');
    } else {
      console.log('some other reason');
    }
  });

axios.cancelAll();

// aborts all HTTP request, and cancels all promises
// logs `request 1 cancelled`
// logs `request 2 cancelled`

```

## Methods

*axiosCancel(instance: axios[, options])*

*options*
- debug _(enables logging)_

*axios.cancel(requestId: string[, reason: string])*

*axios.cancelAll([reason: string])*

## License

MIT

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