axios-retry-fork

1.2.0 • Public • Published

axios-retry

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

Installation

npm install axios-retry

Usage

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

Options

Name Type Default Description
retries Number 3 The number of times to retry before failing
retryCondition Function error => !error.response && error.code !== 'ECONNABORTED' A callback to further control if a request should be retried. By default, it retries if the result did not have a response and the errorcode is not 'ECONNABORTED'.
useIsRetryAllowed Boolean true use the "is-retry-allowed" module additionally to the retryCondition function to determine if the request should be retried

Testing

Clone the repository and execute:

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
  5. Push to the branch: git push origin my-new-feature
  6. Submit a pull request :D

Dependencies (1)

Dev Dependencies (10)

Package Sidebar

Install

npm i axios-retry-fork

Weekly Downloads

4

Version

1.2.0

License

Apache-2.0

Last publish

Collaborators

  • erdii