mirror of
https://github.com/arthurfiorette/axios-cache-interceptor.git
synced 2025-12-08 17:36:16 +00:00
7293cf0c26
* feat: added issue template * fix: move dev bundles to a specific folder * docs: some documentation changes * docs: updated issue template * chore!: updated build setup * style: formatted code * chore: allow importing any file
93 lines
3.3 KiB
Markdown
93 lines
3.3 KiB
Markdown
# Getting Started
|
|
|
|
This library prevents every request made from being sent over the network. This is done by
|
|
intercepting all requests and analyzing each one to see if that request has been made
|
|
before. If it has, it will check if its not expired and return the cached response. If it
|
|
hasn't, it will send the request over the network, as axios would do normally, and cache
|
|
the response received for future requests.
|
|
|
|
This library preserves 100% of the axios api, so after applying it with
|
|
[`setupCache()`](pages/usage-examples#applying), your code won't change or break.
|
|
|
|
```js #runkit
|
|
const Axios = require('axios');
|
|
const {
|
|
setupCache,
|
|
buildMemoryStorage,
|
|
defaultKeyGenerator,
|
|
defaultHeaderInterpreter
|
|
} = require('axios-cache-interceptor');
|
|
|
|
const axios = setupCache(
|
|
// axios instance
|
|
Axios.create(),
|
|
|
|
// All options with their default values
|
|
{
|
|
// The storage to save the cache data. There are more available by default.
|
|
//
|
|
// https://axios-cache-interceptor.js.org/#/pages/storages
|
|
storage: buildMemoryStorage(),
|
|
|
|
// The mechanism to generate a unique key for each request.
|
|
//
|
|
// https://axios-cache-interceptor.js.org/#/pages/request-id
|
|
generateKey: defaultKeyGenerator,
|
|
|
|
// The mechanism to interpret headers (when cache.interpretHeader is true).
|
|
//
|
|
// https://axios-cache-interceptor.js.org/#/pages/global-configuration?id=headerinterpreter
|
|
headerInterpreter: defaultHeaderInterpreter,
|
|
|
|
// The function that will receive debug information.
|
|
// NOTE: For this to work, you need to enable development mode.
|
|
//
|
|
// https://axios-cache-interceptor.js.org/#/pages/development-mode
|
|
// https://axios-cache-interceptor.js.org/#/pages/global-configuration?id=debug
|
|
debug: undefined
|
|
}
|
|
);
|
|
|
|
const { data } = await axios.get('url', {
|
|
// All per-request options lives under the `cache` property.
|
|
cache: {
|
|
// The time until the cached value is expired in milliseconds.
|
|
ttl: 1000 * 60 * 5,
|
|
|
|
// If the request should configure the cache based on some standard cache headers, Like
|
|
// Cache-Control, Expires and so on...
|
|
interpretHeader: false,
|
|
|
|
// All methods that should activate cache behaviors. If the method is not in this list,
|
|
// it will be completely ignored.
|
|
methods: ['get'],
|
|
|
|
// A predicate object that will be used in each request to determine if the request can
|
|
// be cached or not.
|
|
//
|
|
// https://axios-cache-interceptor.js.org/#/pages/per-request-configuration?id=cachecachepredicate
|
|
cachePredicate: {
|
|
statusCheck: (status) => status >= 200 && status < 400
|
|
},
|
|
|
|
// All requests that should have their cache updated once this request is resolved.
|
|
// Normally used to update similar requests or records with newer data.
|
|
//
|
|
// https://axios-cache-interceptor.js.org/#/pages/per-request-configuration?id=cacheupdate
|
|
update: {},
|
|
|
|
// If the support for ETag and If-None-Match headers is active. You can use a string to
|
|
// force a custom value for the ETag response.
|
|
//
|
|
etag: false,
|
|
|
|
// If we should interpret the If-Modified-Since header when generating a TTL value.
|
|
modifiedSince: false,
|
|
|
|
// If we should return a old (possibly expired) cache when the current request failed
|
|
// to get a valid response because of a network error, invalid status or etc.
|
|
staleIfError: false
|
|
}
|
|
});
|
|
```
|