Package Exports
- axios-retry
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (axios-retry) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
axios-retry
Axios plugin that intercepts failed requests and retries them whenever posible.
Installation
npm install axios-retryUsage
// 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'
});
// 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: 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 |
error => !error.response |
A callback to further control if a request should be retried. By default, it retries if the result did not have a response. |
Testing
Clone the repository and execute:
npm testContribute
- 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