# @aevaldas/axios-retry

> Axios plugin that intercepts failed requests and retries them whenever posible.

Latest version **3.1.3** (published 2020-02-13) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @aevaldas/axios-retry
pnpm add @aevaldas/axios-retry
yarn add @aevaldas/axios-retry
bun add @aevaldas/axios-retry
```

## 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 | 3.1.3 |
| Published | 2020-02-13 |
| First published | 2020-02-13 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 41.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2013 |
| Author | Rubén Norte |
| Maintainers | aevaldas |

## Links

- npm: https://www.npmjs.com/package/@aevaldas/axios-retry
- Repository: https://github.com/softonic/axios-retry
- Issues: https://github.com/softonic/axios-retry/issues
- npm.io page: https://npm.io/package/@aevaldas/axios-retry

## Dependencies (1)

- [is-retry-allowed](https://npm.io/package/is-retry-allowed.md) ^1.1.0

## Recent versions

- 3.1.3 (latest) — 2020-02-13
- 3.1.2 — 2020-02-13

## README

# axios-retry

[![Build Status](https://travis-ci.org/softonic/axios-retry.svg?branch=master)](https://travis-ci.org/softonic/axios-retry)

Axios plugin that intercepts failed requests and retries them whenever possible.

## Installation

```bash
npm install axios-retry
```

### Note
Not working with `axios 0.19.0`. For details see the [bug](https://github.com/axios/axios/issues/2203). [`axios 0.19.1`](https://github.com/axios/axios/releases/tag/0.19.1) has fixed this bug.

## Usage

```js
// CommonJS
// const axiosRetry = require('axios-retry');

// ES6
import axiosRetry from 'axios-retry';

axiosRetry(axios, { retries: 3 });

axios.get('http://example.com/test') // The first request fails and the second returns 'ok'
  .then(result => {
    result.data; // 'ok'
  });

// Exponential back-off retry delay between requests
axiosRetry(axios, { retryDelay: axiosRetry.exponentialDelay});

// Custom retry delay
axiosRetry(axios, { retryDelay: (retryCount) => {
  return retryCount * 1000;
}});

// Works with custom axios instances
const client = axios.create({ baseURL: 'http://example.com' });
axiosRetry(client, { retries: 3 });

client.get('/test') // The first request fails and the second returns 'ok'
  .then(result => {
    result.data; // 'ok'
  });

// Allows request-specific configuration
client
  .get('/test', {
    'axios-retry': {
      retries: 0
    }
  })
  .catch(error => { // The first request fails
    error !== undefined
  });

// Allows retries on status-code-200 responses to work around poorly-written APIs
/**
 * @returns {boolean}
 **/
const shouldRetrySuccessResponse = (responseBody) => {
  return responseBody.errorMessage && responseBody.errorMessage.includes('too many requests');
};

axiosRetry(client, { shouldRetrySuccessResponse });

client.get('/test')  // Retries until shouldRetrySuccessResponse returns false or another no-retry condition is met
  .then(result => {
    result.data; // 'ok'
  });
```

**Note:** Unless `shouldResetTimeout` is set, the plugin interprets the request timeout as a global value, so it is not used for each retry but for the whole request lifecycle.

## Options

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| retries | `Number` | `3` | The number of times to retry before failing. |
| retryCondition | `Function` | `isNetworkOrIdempotentRequestError` | A callback to further control if a request should be retried.  By default, it retries if it is a network error or a 5xx error on an idempotent request (GET, HEAD, OPTIONS, PUT or DELETE). |
| retryDelay | `Function` | `function noDelay() { return 0; }` | A callback to further control the delay between retried requests. By default there is no delay between retries. Another option is exponentialDelay ([Exponential Backoff](https://developers.google.com/analytics/devguides/reporting/core/v3/errors#backoff)). The function is passed `retryCount` and `error`. |
| shouldResetTimeout | `Boolean` | false | Defines if the timeout should be reset between retries |
| shouldRetrySuccessResponse | `Function` | `function shouldRetrySuccessResponse() { return false; }` | A function to control if a response with a 200 status code should be retried.  Useful when you need to use APIs that send 200 status codes when an error status code (e.g. 429) is more appropriate. The function is passed the server's response body (not the entire response; just the [HTTP response body](https://developer.mozilla.org/en-US/docs/Web/HTTP/Messages#Body_2)).  |  

## Testing

Clone the repository and execute:

```bash
npm test
```

## Contribute

1. Fork it: `git clone https://github.com/softonic/axios-retry.git`
2. Create your feature branch: `git checkout -b feature/my-new-feature`
3. Commit your changes: `git commit -am 'Added some feature'`
4. Check the build: `npm run build`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

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