README.md

English | 中文

@cutting-mat/axios

The upgraded alternative of Axios, which has the same API as Axios, no side effects, only extends the caching function for the Instance.get() method

Getting started

1. install with npm:

npm i @cutting-mat/axios --save

2. Create Axios instance

import axios from "@cutting-mat/axios";
const instance = axios.create();

3. Send get request (the only difference from Axios)

// Original API
instance.get(url[, config])
// Expand to
instance.get(url[, config[, cacheConfig]])

cacheConfig

• Enable caching

instance.get(
  `/url`,
  { params: 1 },
  {
    cache: true,
  }
);

• Close and clear cache

instance.get(
  `/url`,
  { params: 1 },
  {
    cache: false,
  }
);
// Equivalent to
instance.get(`/url`, { params: 1 });

• Update cache

instance.get(
  `/url`,
  { params: 1 },
  {
    cache: "update",
  }
);

Note

• Only ` instance.get() 'method takes effect. You must call 'create()' to create an instance before using it
• The default is to do anti-shake on concurrent requests, to force concurrency you need to set cache: 'update'

License

MIT