mjsarfatti/axios-auth-refresh

Axios plugin which makes it very easy to automatically refresh the authorization tokens of your clients

axios-auth-refresh

Axios plugin that makes it easy to implement automatic refresh of authorization via axios' interceptors.

Size: 1.43 KiB minified, 1.06 KiB gzipped

Installation

Installing using npm or yarn

npm install axios-auth-refresh
# or
yarn add axios-auth-refresh

Syntax

createAuthRefreshInterceptor(axios, function refreshAuthLogic () {
    // Return a Promise
});

Parameters

• axios - an instance of Axios used in project/call
• refreshAuthLogic - a Function used for refreshing authentication (must return a promise)

Usage

In order to activate the interceptors, you need to import a function from axios-auth-refresh which is exported by default and call it with the axios instance you want the interceptors for, as well as the refresh authorization function where you need to write the logic for refreshing the authorization.

The interceptors will then be bind onto the axios instance and logic will be ran whenever 401 (Unauthorized) status is returned from a server. All new requests created while the refreshAuthLogic is processed will be bind onto the Promise returned from the refreshAuthLogic function.

import axios from 'axios';
import createAuthRefreshInterceptor from 'axios-auth-refresh';

// Function that will be called to refresh authorization
const refreshAuthLogic = () => axios.post('https://www.example.com/auth/token/refresh').then(res => {
    localStorage.setItem('token', res.data.token);
    return Promise.resolve();
});

// Instantiate the interceptor (you can chain it as it returns the axios instance)
createAuthRefreshInterceptor(axios, refreshAuthLogic);

// Make a call
axios.get('https://www.example.com/restricted/area')
    .then(/* ... */)
    .catch(/* ... */);