axios-retry

What is axios-retry?

The axios-retry npm package is a utility that allows you to automatically retry failed HTTP requests made using the Axios library. It is particularly useful for dealing with transient errors or unstable network conditions. It provides several options to customize the retry behavior, such as the number of retries, retry delay, and the conditions for which requests should be retried.

What are axios-retry's main functionalities?

Automatic Retries

Automatically retries a failed HTTP request up to a specified number of times.

const axios = require('axios');
const axiosRetry = require('axios-retry');

axiosRetry(axios, { retries: 3 });

axios.get('https://example.com').catch(error => {
  console.error('Request failed:', error);
});

Custom Retry Conditions

Allows you to specify custom conditions for when a request should be retried, such as on certain HTTP status codes or network errors.

const axios = require('axios');
const axiosRetry = require('axios-retry');

axiosRetry(axios, {
  retryCondition: (error) => {
    // Retry on any network error, or 5xx status codes
    return axiosRetry.isNetworkOrIdempotentRequestError(error) || error.response.status === 503;
  }
});

Exponential Backoff

Implements an exponential backoff strategy for the delay between retries, which can help to avoid overwhelming the server.

const axios = require('axios');
const axiosRetry = require('axios-retry');

axiosRetry(axios, {
  retries: 5,
  retryDelay: (retryCount) => {
    return axiosRetry.exponentialDelay(retryCount);
  }
});

Retry on Idempotent Requests Only

Configures the retry mechanism to only retry idempotent requests, which are requests that can be repeated without causing additional side effects.

const axios = require('axios');
const axiosRetry = require('axios-retry');

axiosRetry(axios, {
  retries: 3,
  shouldResetTimeout: true,
  retryCondition: axiosRetry.isIdempotentRequestError
});

Other packages similar to axios-retry

retry-axios

retry-axios is an npm package that provides similar functionality to axios-retry. It allows you to attach retry functionality to Axios requests and configure the number of retries, backoff strategy, and more. It differs in its API and configuration options, offering a different approach to attaching retry behavior to Axios instances or requests.

superagent-retry-delay

superagent-retry-delay is an npm package that extends the Superagent HTTP request library with retry functionality. While it serves a similar purpose to axios-retry, it is specific to Superagent rather than Axios. It allows for configuring retries and delays but is not directly compatible with Axios.

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

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

Changelog

[4.5.0] - 2024-08-02

• added linearDelay function