axios-retry

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

Apache-2.0 48 个版本

安装

npm install axios-retry

yarn add axios-retry

pnpm add axios-retry

bun add axios-retry

README

axios-retry

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

Installation

npm install axios-retry

Usage

// CommonJS
// const axiosRetry = require('axios-retry').default;

// 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 });

// Liner retry delay between requests
axiosRetry(axios, { retryDelay: axiosRetry.linearDelay() });

// 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
  });

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. 1 = One retry after first failure
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).
shouldResetTimeout	`Boolean`	false	Defines if the timeout should be reset between retries
retryDelay	`Function`	`function noDelay() { return 0; }`	A callback to further control the delay in milliseconds between retried requests. By default there is no delay between retries. Another option is exponentialDelay (Exponential Backoff) or `linearDelay`. The function is passed `retryCount` and `error`.
onRetry	`Function`	`function onRetry(retryCount, error, requestConfig) { return; }`	A callback to notify when a retry is about to occur. Useful for tracing and you can any async process for example refresh a token on 401. By default nothing will occur. The function is passed `retryCount`, `error`, and `requestConfig`.
onMaxRetryTimesExceeded	`Function`	`function onMaxRetryTimesExceeded(error, retryCount) { return; }`	After all the retries are failed, this callback will be called with the last error before throwing the error.
validateResponse	`Function \| null`	`null`	A callback to define whether a response should be resolved or rejected. If null is passed, it will fallback to the axios default (only 2xx status codes are resolved).

Testing

Clone the repository and execute:

npm test

Contribute

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

版本列表

4.5.0 2024-08-02

4.4.2 2024-07-22

4.4.1 2024-06-21

4.4.0 2024-06-04

4.3.0 2024-05-20

4.2.0 2024-05-15

4.1.0 2024-03-19

4.0.0 2023-11-25

3.9.1 2023-11-16

3.9.0 2023-11-14

3.8.2 2023-11-14

3.8.1 2023-10-26

3.8.0 2023-09-21

3.7.0 2023-08-28

3.6.1 2023-08-25

3.6.0 2023-07-28

3.5.1 2023-06-27

3.5.0 2023-05-18

3.4.0 2023-01-20

3.3.1 2022-06-29

3.3.0 2022-06-28

3.2.6 2022-06-28

3.2.5 2022-04-29

3.2.4 2021-10-27

3.2.3 2021-10-19

3.2.2 2021-10-14

3.2.1 2021-10-14

3.2.0 2021-09-28

3.1.9 2020-09-18

3.1.8 2020-04-24

3.1.7 2020-04-23

3.1.6 2020-04-21

3.1.5 2020-04-20

3.1.4 2020-04-18

3.1.2 2019-01-24

3.1.1 2018-06-13

3.1.0 2018-04-26

3.0.2 2018-02-09

3.0.1 2017-08-16

3.0.0 2017-08-13

2.0.1 2017-06-19

2.0.0 2017-06-15

1.3.1 2017-06-19

1.3.0 2017-06-15

1.2.0 2017-03-07

1.1.1 2017-02-01

1.1.0 2016-11-13

1.0.0 2016-11-13