axios-retry-after

A tiny HTTP retry interceptor for axios.

This interceptor catches HTTP 429 errors, reads the Retry-After header, and retries the request at the proper type.

Installation

With NPM:

1npm install --save axios-retry-after

With Yarn:

1yarn add axios-retry-after

Example usage

1import axios from 'axios'
2import retry from 'axios-retry-after'
3const client = axios.createClient()
4client.interceptors.response.use(null, retry(client))

Customizing retry behavior

You can optionally customize the behavior of this interceptor by passing a second argument including one or more of the methods demonstrated below:

1client.interceptors.response.use(null, retry(client, {
2  // Determine when we should attempt to retry
3  isRetryable (error) {
4    return (
5      error.response && error.response.status === 429 &&
6      // Use X-Retry-After rather than Retry-After, and cap retry delay at 60 seconds
7      error.response.headers['x-retry-after'] && error.response.headers['x-retry-after'] <= 60
8    )
9  }
10
11  // Customize the wait behavior
12  wait (error) {
13    return new Promise(
14      // Use X-Retry-After rather than Retry-After 
15      resolve => setTimeout(resolve, error.response.headers['x-retry-after'])
16    )
17  }
18
19  // Customize the retry request itself
20  retry (axios, error) {
21    if (!error.config) {
22      throw error
23    }
24
25    // Apply request customizations before retrying
26    // ...
27
28    return axios(error.config)
29  }
30}))