axios-cache-interceptor/docs/pages/usage-examples.md

Usage and Examples

There are some other examples in the [examples](https://, check them out! You can also make a PR to add some more.

Applying

This library is based on axios interceptors, so, under the hood, it uses axios.interceptors.use() to apply the interceptors. But you don't. All you have to do is call setupCache and you are ready to go!

import { setupCache } from 'axios-cache-interceptor';

setupCache(axios);

How to get the axios instance

There are two types of axios instances, the AxiosStatic and the AxiosInstance. The AxiosStatic is the default instance of axios. The AxiosInstance is the instance you get when you call axios.create().

Both of them work seamlessly, but when messing with the axios static, your hole code, including those libraries you don't even know that they exists, are also affected. You should be careful when using it.

// AxiosStatic
import axios from 'axios';

// AxiosInstance
const instance = axios.create();

Customizing behaviors

You can customize the behaviors of this library in two ways, in a per request or in a global way.

const Axios = require('axios');
const { setupCache } = require('axios-cache-interceptor');

const instance = Axios.create({
  /** Here you can pass the axios options * */
});

// Global options
setupCache(instance, {
  /** Here you can pass the interceptor options * */
});

// Per request options
const result = await instance.get('https://jsonplaceholder.typicode.com/posts/1', {
  /** Override axios options * */
  cache: {
    /** Override cache options * */
  }
});

console.log('Result:', result.data);

Nodejs server example

An NodeJS with ExpressJS example to return data from another api.

const express = require('express');
const app = express();

const Axios = require('axios');
const { setupCache } = require('axios-cache-interceptor');

const api = setupCache(
  Axios.create({ baseURL: 'https://jsonplaceholder.typicode.com/' }),
  // 5 seconds
  { ttl: 5 * 1000 }
);

// Every time an api call reaches here, it will
// make another internal request and forward the response.
app.get('/', (req, res) => {
  api.get('/users').then(
    ({ data, cached, id }) => {
      res.json({
        cached,
        id: {
          value: id,
          deleteUrl: `/cache/${id}/delete`,
          getUrl: `/cache/${id}/get`
        },
        data
      });
    },
    (error) => {
      res.json({ error });
    }
  );
});

app.get('/cache/:id/delete', async (req, res) => {
  await api.storage.remove(req.params.id);
  res.send({
    status: 'Deleted!',
    current: await api.storage.get(req.params.id)
  });
});

app.get('/cache/:id/get', async (req, res) => {
  const cache = await api.storage.get(req.params.id);
  res.json(cache);
});

app.listen(3000);

Jsx component example

You shouldn't store cache in state libraries, it even is a bad practice. And even if you do so, you probably will have to write a lot of code to handle cache invalidation, strategies and etc.

With this library, you can just call any axios method without worrying about requesting thousands of times for every component draw. Simple as that!

function Component() {
  // React component state (but can be from any other framework, library and etc)
  const [data, setData] = useState(null);

  // Calling this function every component redraw does not have any
  // problems, as the response is cached in the first request. This
  // even work with concurrent requests and for many components at
  // the same time
  axios.get('https://api.example.com').then((response) => {
    setData(response.data);
  });

  return (
    <div class=":)">
      <div>{data}</div>
    </div>
  );
}