mirror of
https://github.com/arthurfiorette/axios-cache-interceptor.git
synced 2025-12-08 17:36:16 +00:00
58 lines
38 KiB
HTML
58 lines
38 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US" dir="ltr">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>Introduction | Axios Cache Interceptor</title>
|
||
|
||
<meta name="generator" content="VitePress v1.6.4">
|
||
<link rel="preload stylesheet" href="/assets/style.DjhVb9s0.css" as="style">
|
||
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
|
||
|
||
<script type="module" src="/assets/app.DeV0lJp_.js"></script>
|
||
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
|
||
<link rel="modulepreload" href="/assets/chunks/theme.DpzYL1kV.js">
|
||
<link rel="modulepreload" href="/assets/chunks/framework.CnuuF8_c.js">
|
||
<link rel="modulepreload" href="/assets/guide.md.Ch_3Blm4.lean.js">
|
||
<link rel="icon" href="/favicon.ico', type: 'image/x-icon">
|
||
<link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
|
||
<link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
|
||
<link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
|
||
<link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
|
||
<link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
|
||
<link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
|
||
<link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
|
||
<link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
|
||
<link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
|
||
<link rel="icon" type="image/png" sizes="192x192" href="/android-icon-192x192.png">
|
||
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
|
||
<link rel="icon" type="image/png" sizes="96x96" href="/favicon-96x96.png">
|
||
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
|
||
<link rel="manifest" href="/manifest.json">
|
||
<meta name="msapplication-TileColor" content="#e5972a">
|
||
<meta name="msapplication-TileImage" content="/ms-icon-144x144.png">
|
||
<meta name="theme-color" content="#e5972a">
|
||
<meta name="description" content="Small and efficient cache interceptor for axios. Etag, Cache-Control, TTL, HTTP headers and more!">
|
||
<meta property="og:url" content="https://axios-cache-interceptor.js.org">
|
||
<meta property="og:type" content="website">
|
||
<meta property="og:title" content="Axios Cache Interceptor">
|
||
<meta property="og:description" content="Small and efficient cache interceptor for axios. Etag, Cache-Control, TTL, HTTP headers and more!">
|
||
<meta property="og:image" content="/preview.png">
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta property="twitter:domain" content="axios-cache-interceptor.js.org">
|
||
<meta property="twitter:url" content="https://axios-cache-interceptor.js.org">
|
||
<meta name="twitter:title" content="Axios Cache Interceptor">
|
||
<meta name="twitter:description" content="Small and efficient cache interceptor for axios. Etag, Cache-Control, TTL, HTTP headers and more!">
|
||
<meta name="twitter:image" content="/preview.png">
|
||
<meta name="google-site-verification" content="u9Nw6WpRrWDhdPTAv-LGIE9aJ0C15t7zkjuaUizDJnA">
|
||
<script defer data-domain="axios-cache-interceptor.js.org" src="https://metrics.arthur.one/js/script.js"></script>
|
||
<script type="application/ld+json">{"@context":"http://www.schema.org","@type":"Organization","name":"Axios Cache Interceptor","url":"https://axios-cache-interceptor.js.org","sameAs":["https://github.com/ArthurFiorette/axios-cache-interceptor"],"datePublished":"2022-01-17","dateModified":"2022-01-17","logo":"https://axios-cache-interceptor.js.org/preview.png","image":"https://axios-cache-interceptor.js.org/preview.png","description":"Axios Cache Interceptor is a small and efficient cache interceptor for axios.","headline":"A small and efficient cache interceptor for axios."}</script>
|
||
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
|
||
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
|
||
</head>
|
||
<body>
|
||
<div id="app"><div class="Layout" data-v-de37206a><!--[--><!--]--><!--[--><span tabindex="-1" data-v-77a352a9></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-77a352a9>Skip to content</a><!--]--><!----><header class="VPNav" data-v-de37206a data-v-6d80760b><div class="VPNavBar" data-v-6d80760b data-v-dd18e3da><div class="wrapper" data-v-dd18e3da><div class="container" data-v-dd18e3da><div class="title" data-v-dd18e3da><div class="VPNavBarTitle has-sidebar" data-v-dd18e3da data-v-45adfdaa><a class="title" href="/" data-v-45adfdaa><!--[--><!--]--><!--[--><img class="VPImage logo" src="/rocket.svg" alt data-v-8ebc39c0><!--]--><span data-v-45adfdaa>Axios Cache Interceptor</span><!--[--><!--]--></a></div></div><div class="content" data-v-dd18e3da><div class="content-body" data-v-dd18e3da><!--[--><!--]--><div class="VPNavBarSearch search" data-v-dd18e3da><!--[--><!----><div id="docsearch"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-dd18e3da data-v-80fc4413><span id="main-nav-aria-label" class="visually-hidden" data-v-80fc4413> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/guide" tabindex="0" data-v-80fc4413 data-v-77375007><!--[--><span data-v-77375007>Guide</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/config" tabindex="0" data-v-80fc4413 data-v-77375007><!--[--><span data-v-77375007>Config</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/others/license" tabindex="0" data-v-80fc4413 data-v-77375007><!--[--><span data-v-77375007>Others</span><!--]--></a><!--]--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-80fc4413 data-v-1893426f><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-1893426f><span class="text" data-v-1893426f><!----><span data-v-1893426f>Latest</span><span class="vpi-chevron-down text-icon" data-v-1893426f></span></span></button><div class="menu" data-v-1893426f><div class="VPMenu" data-v-1893426f data-v-423530b0><div class="items" data-v-423530b0><!--[--><!--[--><div class="VPMenuLink" data-v-423530b0 data-v-cae06d8f><a class="VPLink link vp-external-link-icon" href="https://axios-cache-interceptor.js.org/v0/" target="_blank" rel="noreferrer" data-v-cae06d8f><!--[--><span data-v-cae06d8f>v0.x</span><!--]--></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-dd18e3da data-v-c06afdfa><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-c06afdfa data-v-3b05a2ba data-v-6f4e89fa><span class="check" data-v-6f4e89fa><span class="icon" data-v-6f4e89fa><!--[--><span class="vpi-sun sun" data-v-3b05a2ba></span><span class="vpi-moon moon" data-v-3b05a2ba></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-dd18e3da data-v-43977e51 data-v-5af2a0df><!--[--><a class="VPSocialLink no-icon" href="https://axios-cache-interceptor.js.org/discord" aria-label="discord" target="_blank" rel="noopener" data-v-5af2a0df data-v-5297b9ec><span class="vpi-social-discord"></span></a><a class="VPSocialLink no-icon" href="https://github.com/arthurfiorette/axios-cache-interceptor" aria-label="github" target="_blank" rel="noopener" data-v-5af2a0df data-v-5297b9ec><span class="vpi-social-github"></span></a><a class="VPSocialLink no-icon" href="https://npmjs.com/package/axios-cache-interceptor" aria-label target="_blank" rel="noopener" data-v-5af2a0df data-v-5297b9ec><svg xmlns="http://www.w3.org/2000/svg" role="img" viewBox="0 0 24 24"><title>npm</title><path d="M1.763 0C.786 0 0 .786 0 1.763v20.474C0 23.214.786 24 1.763 24h20.474c.977 0 1.763-.786 1.763-1.763V1.763C24 .786 23.214 0 22.237 0zM5.13 5.323l13.837.019-.009 13.836h-3.464l.01-10.382h-3.456L12.04 19.17H5.113z"/></svg></a><a class="VPSocialLink no-icon" href="https://www.jsdelivr.com/package/npm/axios-cache-interceptor" aria-label target="_blank" rel="noopener" data-v-5af2a0df data-v-5297b9ec><svg xmlns="http://www.w3.org/2000/svg" role="img" viewBox="0 0 24 24"><title>jsDelivr</title><path d="M11.851 0L.811 4.02l1.56 14.7L11.85 24l9.6-5.28 1.74-14.76zm.062 4.622a6.668 6.75 0 0 1 2.666.572 12.507 12.507 0 0 0-2.59 1.95c-.045-.02-.092-.031-.138-.045a1.181 1.181 0 0 0-.346-.056c-.071 0-.141.01-.21.021a8.91 8.91 0 0 1-.615-2.318 6.668 6.75 0 0 1 1.171-.122 6.668 6.75 0 0 1 .062-.002zm-1.99.312a9.763 9.763 0 0 0 .69 2.504 1.213 1.213 0 0 0-.328.825 1.202 1.202 0 0 0 .18.63c-.937 1.294-1.656 2.803-1.905 4.31-.01.056-.013.11-.02.166-.282.09-.515.284-.656.54-.987-.333-1.885-.968-2.615-2.022a6.668 6.75 0 0 1-.026-.515 6.668 6.75 0 0 1 4.68-6.438zm5.507.709a6.668 6.75 0 0 1 2.53 2.9c-.377.953-1.049 1.892-1.893 2.727a1.242 1.242 0 0 0-.644-.184 1.243 1.243 0 0 0-.768.27c-.462-.354-.91-.737-1.318-1.168-.333-.35-.637-.73-.921-1.123.19-.215.31-.494.31-.802 0-.212-.061-.41-.159-.586 1.058-1.008 2.112-1.67 2.863-2.034zm-3.925 1.982a.624.624 0 0 1 .346.114.624.624 0 0 1 .292.524.624.624 0 0 1-.292.524.626.626 0 0 1-.346.113.634.634 0 0 1-.638-.637c0-.355.283-.638.638-.638zm-.441 1.771a1.205 1.205 0 0 0 .675.062c.036.05.075.097.112.148a11.438 11.438 0 0 0 .921 1.119 12.103 12.103 0 0 0 1.446 1.277c-.032.11-.054.224-.054.342a1.236 1.236 0 0 0 .066.38 9.91 9.91 0 0 1-2.118 1.042c-.087.029-.173.052-.261.078a7.735 7.735 0 0 1-1.87.332 1.15 1.15 0 0 0-.66-.773c.004-.024.005-.049.01-.073.219-1.333.873-2.73 1.733-3.934zm7.272.19a6.668 6.75 0 0 1 .245 1.786 6.668 6.75 0 0 1-.259 1.856 9.993 9.993 0 0 1-1.666-.63 1.243 1.243 0 0 0-.065-.713 9.434 9.434 0 0 0 1.745-2.3zm-2.913 2.101c.367 0 .657.291.657.658s-.291.657-.657.657c-.367 0-.658-.29-.658-.657s.29-.658.658-.658zm.837 1.59a10.79 10.79 0 0 0 1.802.688 6.668 6.75 0 0 1-6.149 4.157 6.668 6.75 0 0 1-.062-.004 6.668 6.75 0 0 1-.042 0c-.087-.042-.168-.08-.266-.129-.312-.154-.667-.352-.846-.5a3.796 3.796 0 0 1-1.294-2.03c.21-.111.38-.284.487-.495a8.428 8.428 0 0 0 1.96-.306 9.11 9.11 0 0 0 .513-.154 11.083 11.083 0 0 0 2.341-1.13c.205.143.452.23.719.23a1.248 1.248 0 0 0 .837-.328zm-10.707.116a5.761 5.761 0 0 0 2.212 1.298 1.146 1.146 0 0 0 .857.87 4.602 4.602 0 0 0 1.24 2.222 6.668 6.75 0 0 1-4.31-4.39zm3.327.464c.331 0 .595.263.595.596s-.264.595-.595.595a.59.59 0 0 1-.596-.595.591.591 0 0 1 .596-.596z"/></svg></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-dd18e3da data-v-96f668d2 data-v-1893426f><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-1893426f><span class="vpi-more-horizontal icon" data-v-1893426f></span></button><div class="menu" data-v-1893426f><div class="VPMenu" data-v-1893426f data-v-423530b0><!----><!--[--><!--[--><!----><div class="group" data-v-96f668d2><div class="item appearance" data-v-96f668d2><p class="label" data-v-96f668d2>Appearance</p><div class="appearance-action" data-v-96f668d2><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-96f668d2 data-v-3b05a2ba data-v-6f4e89fa><span class="check" data-v-6f4e89fa><span class="icon" data-v-6f4e89fa><!--[--><span class="vpi-sun sun" data-v-3b05a2ba></span><span class="vpi-moon moon" data-v-3b05a2ba></span><!--]--></span></span></button></div></div></div><div class="group" data-v-96f668d2><div class="item social-links" data-v-96f668d2><div class="VPSocialLinks social-links-list" data-v-96f668d2 data-v-5af2a0df><!--[--><a class="VPSocialLink no-icon" href="https://axios-cache-interceptor.js.org/discord" aria-label="discord" target="_blank" rel="noopener" data-v-5af2a0df data-v-5297b9ec><span class="vpi-social-discord"></span></a><a class="VPSocialLink no-icon" href="https://github.com/arthurfiorette/axios-cache-interceptor" aria-label="github" target="_blank" rel="noopener" data-v-5af2a0df data-v-5297b9ec><span class="vpi-social-github"></span></a><a class="VPSocialLink no-icon" href="https://npmjs.com/package/axios-cache-interceptor" aria-label target="_blank" rel="noopener" data-v-5af2a0df data-v-5297b9ec><svg xmlns="http://www.w3.org/2000/svg" role="img" viewBox="0 0 24 24"><title>npm</title><path d="M1.763 0C.786 0 0 .786 0 1.763v20.474C0 23.214.786 24 1.763 24h20.474c.977 0 1.763-.786 1.763-1.763V1.763C24 .786 23.214 0 22.237 0zM5.13 5.323l13.837.019-.009 13.836h-3.464l.01-10.382h-3.456L12.04 19.17H5.113z"/></svg></a><a class="VPSocialLink no-icon" href="https://www.jsdelivr.com/package/npm/axios-cache-interceptor" aria-label target="_blank" rel="noopener" data-v-5af2a0df data-v-5297b9ec><svg xmlns="http://www.w3.org/2000/svg" role="img" viewBox="0 0 24 24"><title>jsDelivr</title><path d="M11.851 0L.811 4.02l1.56 14.7L11.85 24l9.6-5.28 1.74-14.76zm.062 4.622a6.668 6.75 0 0 1 2.666.572 12.507 12.507 0 0 0-2.59 1.95c-.045-.02-.092-.031-.138-.045a1.181 1.181 0 0 0-.346-.056c-.071 0-.141.01-.21.021a8.91 8.91 0 0 1-.615-2.318 6.668 6.75 0 0 1 1.171-.122 6.668 6.75 0 0 1 .062-.002zm-1.99.312a9.763 9.763 0 0 0 .69 2.504 1.213 1.213 0 0 0-.328.825 1.202 1.202 0 0 0 .18.63c-.937 1.294-1.656 2.803-1.905 4.31-.01.056-.013.11-.02.166-.282.09-.515.284-.656.54-.987-.333-1.885-.968-2.615-2.022a6.668 6.75 0 0 1-.026-.515 6.668 6.75 0 0 1 4.68-6.438zm5.507.709a6.668 6.75 0 0 1 2.53 2.9c-.377.953-1.049 1.892-1.893 2.727a1.242 1.242 0 0 0-.644-.184 1.243 1.243 0 0 0-.768.27c-.462-.354-.91-.737-1.318-1.168-.333-.35-.637-.73-.921-1.123.19-.215.31-.494.31-.802 0-.212-.061-.41-.159-.586 1.058-1.008 2.112-1.67 2.863-2.034zm-3.925 1.982a.624.624 0 0 1 .346.114.624.624 0 0 1 .292.524.624.624 0 0 1-.292.524.626.626 0 0 1-.346.113.634.634 0 0 1-.638-.637c0-.355.283-.638.638-.638zm-.441 1.771a1.205 1.205 0 0 0 .675.062c.036.05.075.097.112.148a11.438 11.438 0 0 0 .921 1.119 12.103 12.103 0 0 0 1.446 1.277c-.032.11-.054.224-.054.342a1.236 1.236 0 0 0 .066.38 9.91 9.91 0 0 1-2.118 1.042c-.087.029-.173.052-.261.078a7.735 7.735 0 0 1-1.87.332 1.15 1.15 0 0 0-.66-.773c.004-.024.005-.049.01-.073.219-1.333.873-2.73 1.733-3.934zm7.272.19a6.668 6.75 0 0 1 .245 1.786 6.668 6.75 0 0 1-.259 1.856 9.993 9.993 0 0 1-1.666-.63 1.243 1.243 0 0 0-.065-.713 9.434 9.434 0 0 0 1.745-2.3zm-2.913 2.101c.367 0 .657.291.657.658s-.291.657-.657.657c-.367 0-.658-.29-.658-.657s.29-.658.658-.658zm.837 1.59a10.79 10.79 0 0 0 1.802.688 6.668 6.75 0 0 1-6.149 4.157 6.668 6.75 0 0 1-.062-.004 6.668 6.75 0 0 1-.042 0c-.087-.042-.168-.08-.266-.129-.312-.154-.667-.352-.846-.5a3.796 3.796 0 0 1-1.294-2.03c.21-.111.38-.284.487-.495a8.428 8.428 0 0 0 1.96-.306 9.11 9.11 0 0 0 .513-.154 11.083 11.083 0 0 0 2.341-1.13c.205.143.452.23.719.23a1.248 1.248 0 0 0 .837-.328zm-10.707.116a5.761 5.761 0 0 0 2.212 1.298 1.146 1.146 0 0 0 .857.87 4.602 4.602 0 0 0 1.24 2.222 6.668 6.75 0 0 1-4.31-4.39zm3.327.464c.331 0 .595.263.595.596s-.264.595-.595.595a.59.59 0 0 1-.596-.595.591.591 0 0 1 .596-.596z"/></svg></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-dd18e3da data-v-364b8629><span class="container" data-v-364b8629><span class="top" data-v-364b8629></span><span class="middle" data-v-364b8629></span><span class="bottom" data-v-364b8629></span></span></button></div></div></div></div><div class="divider" data-v-dd18e3da><div class="divider-line" data-v-dd18e3da></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-de37206a data-v-ac3c66b6><div class="container" data-v-ac3c66b6><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-ac3c66b6><span class="vpi-align-left menu-icon" data-v-ac3c66b6></span><span class="menu-text" data-v-ac3c66b6>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-ac3c66b6 data-v-39d21923><button data-v-39d21923>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-de37206a data-v-2e8ec0d9><div class="curtain" data-v-2e8ec0d9></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-2e8ec0d9><span class="visually-hidden" id="sidebar-aria-label" data-v-2e8ec0d9> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-4aa9b711><section class="VPSidebarItem level-0" data-v-4aa9b711 data-v-4e886116><!----><div class="items" data-v-4e886116><!--[--><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link vp-external-link-icon link" href="https://chatgpt.com/?model=gpt-4&hints=search&prompt=You+are+a+JavaScript+expert+assistant.+Read+the+entire+content+from+the+following+URL%3A%0A%0Ahttps%3A%2F%2Faxios-cache-interceptor.js.org%2Fllms-full.txt%0AYou+are+free+to+follow+any+links+in+the+document+to+gather+more+information%2C+if+necessary.%0A%0AThe+document+is+a+comprehensive+guide+to+the+%60axios-cache-interceptor%60+library%2C+which+is+used+for+caching+HTTP+requests+in+Axios.%0A%0A**Your+task+is+to%3A**%0A%0A1.+Understand+the+purpose+and+functionality+of+the+library.%0A2.+Learn+the+key+concepts%2C+configuration+options%2C+and+API+methods+described.%0A3.+Retain+information+about+advanced+features%2C+usage+examples%2C+and+edge+cases.%0A4.+Be+ready+to+answer+technical+questions+or+explain+how+to+use+the+library%2C+troubleshoot+common+issues%2C+and+compare+it+with+other+caching+approaches+in+Axios.%0A%0ADo+not+summarize+yet.+Just+read+and+prepare+to+answer+detailed+questions." target="_blank" rel="noreferrer" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Ask ChatGPT</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-4aa9b711><section class="VPSidebarItem level-0 has-active" data-v-4aa9b711 data-v-4e886116><div class="item" role="button" tabindex="0" data-v-4e886116><div class="indicator" data-v-4e886116></div><h2 class="text" data-v-4e886116>Guide</h2><!----></div><div class="items" data-v-4e886116><!--[--><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/guide" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Introduction</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/guide/getting-started" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Getting Started</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/guide/debugging" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Debugging</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/guide/storages" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Storages</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/guide/request-id" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Request Id</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/guide/invalidating-cache" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Invalidating Cache</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/guide/comparison" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Comparison</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/guide/interceptors" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Other Interceptors</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-4aa9b711><section class="VPSidebarItem level-0" data-v-4aa9b711 data-v-4e886116><div class="item" role="button" tabindex="0" data-v-4e886116><div class="indicator" data-v-4e886116></div><h2 class="text" data-v-4e886116>Config</h2><!----></div><div class="items" data-v-4e886116><!--[--><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/config" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Global Configuration</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/config/request-specifics" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Request Specifics</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/config/response-object" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Response Object</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-4aa9b711><section class="VPSidebarItem level-0" data-v-4aa9b711 data-v-4e886116><!----><div class="items" data-v-4e886116><!--[--><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/others/license" data-v-4e886116><!--[--><p class="text" data-v-4e886116>MIT License</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/others/changelog" data-v-4e886116><!--[--><p class="text" data-v-4e886116>Changelog</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/llms.txt" data-v-4e886116><!--[--><p class="text" data-v-4e886116>llms.txt</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-4e886116 data-v-4e886116><div class="item" data-v-4e886116><div class="indicator" data-v-4e886116></div><a class="VPLink link link" href="/llms-full.txt" data-v-4e886116><!--[--><p class="text" data-v-4e886116>llms-full.txt</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-de37206a data-v-6b7662ab><div class="VPDoc has-sidebar has-aside" data-v-6b7662ab data-v-a2dbfda7><!--[--><!--]--><div class="container" data-v-a2dbfda7><div class="aside" data-v-a2dbfda7><div class="aside-curtain" data-v-a2dbfda7></div><div class="aside-container" data-v-a2dbfda7><div class="aside-content" data-v-a2dbfda7><div class="VPDocAside" data-v-a2dbfda7 data-v-12c88fe8><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-12c88fe8 data-v-5791035b><div class="content" data-v-5791035b><div class="outline-marker" data-v-5791035b></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-5791035b>On this page</div><ul class="VPDocOutlineItem root" data-v-5791035b data-v-24355f8a><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-12c88fe8></div><!--[--><!--]--><div class="VPDocAsideCarbonAds" data-v-12c88fe8><div class="VPCarbonAds" data-v-89a5407e></div></div><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-a2dbfda7><div class="content-container" data-v-a2dbfda7><!--[--><!--]--><main class="main" data-v-a2dbfda7><div style="position:relative;" class="vp-doc _guide" data-v-a2dbfda7><div><div style="display:none;" hidden="true" aria-hidden="true">Are you an LLM? You can read better optimized documentation at /guide.md for this page in Markdown format</div><h1 id="introduction" tabindex="-1">Introduction <a class="header-anchor" href="#introduction" aria-label="Permalink to "Introduction""></a></h1><p>Axios Cache Interceptor is a, as it name says, a interceptor for axios to handle caching. It was created to help developers call axios multiple times without having to worry about overloading the network or coding himself a simple and buggy cache system.</p><p>Each request goes through an interceptor applied to your axios instance. There, we handle each request and decide if we should send it to the network or return a cached response.</p><h2 id="how-it-works" tabindex="-1">How it works <a class="header-anchor" href="#how-it-works" aria-label="Permalink to "How it works""></a></h2><p>By using axios interceptors instead of adapters, each request is passed through the interceptor before calling the adapter and before returning to the original caller. Adapters are the final step and they are responsible for the actual network call, so, by choosing to use interceptors, we create a minimally invasive approach that allows you to still use the axios adapter of your choice.</p><p>Before the request is delivered to the adapter, our request interceptor checks if the request have already been cached and if it’s a valid one, checks if the request should be cached (sometimes you don’t want cache at all, and it’s ok), if there’s already a request sent to the network that we can wait for it and many more other checks.</p><p>After the adapter gets the response, we check if it belongs to a <em>cacheable</em> request, saves it into the storage, resolves other requests awaiting for the same resource and finally returns the response to the original caller.</p><h2 id="features" tabindex="-1">Features <a class="header-anchor" href="#features" aria-label="Permalink to "Features""></a></h2><ul><li>TTL, Cache-Control and ETag.</li><li>Return previous cached request if the new one failed.</li><li>Handles parallel requests</li><li>100% Customizable</li><li>Built-in storages like In-Memory, Local Storage and Session Storage.</li><li>Less than 4.3Kb minified and gzipped.</li><li>Development mode to debug your requests.</li><li>22 times faster than using axios and 8% faster than <code>axios-cache-adapter</code>.</li><li>And much more…</li></ul><h2 id="why-not" tabindex="-1">Why not…? <a class="header-anchor" href="#why-not" aria-label="Permalink to "Why not...?""></a></h2><h3 id="axios-cache-adapter" tabindex="-1">axios-cache-adapter <a class="header-anchor" href="#axios-cache-adapter" aria-label="Permalink to "axios-cache-adapter""></a></h3><p>The creation of this library is heavily inspired by axios-cache-adapter. It was a great library but now it is unmaintained and has a lot of unresolved issues. Also, it weights more than 4x the size of this library with less features and less performance.</p><h3 id="fetch-and-some-state-management-library" tabindex="-1">Fetch and some state management library? <a class="header-anchor" href="#fetch-and-some-state-management-library" aria-label="Permalink to "Fetch and some state management library?""></a></h3><p>As this library was built to be used with axios and to handle storage itself, I can assure that it is more performant that any glued code you may find and/or write yourself. About state management libraries and other similar things, <a href="https://arthur.place/implications-of-cache-or-state" target="_blank" rel="noreferrer">this blog post</a> explains why cache is more correct, architectural way, instead of state.</p></div></div></main><footer class="VPDocFooter" data-v-a2dbfda7 data-v-03820f5f><!--[--><!--]--><div class="edit-info" data-v-03820f5f><div class="edit-link" data-v-03820f5f><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/arthurfiorette/axios-cache-interceptor/edit/main/docs/src/guide.md" target="_blank" rel="noreferrer" data-v-03820f5f><!--[--><span class="vpi-square-pen edit-link-icon" data-v-03820f5f></span> Edit this page<!--]--></a></div><div class="last-updated" data-v-03820f5f><p class="VPLastUpdated" data-v-03820f5f data-v-7a07e477>Last updated: <time datetime="2025-10-14T14:21:19.000Z" data-v-7a07e477></time></p></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-03820f5f><span class="visually-hidden" id="doc-footer-aria-label" data-v-03820f5f>Pager</span><div class="pager" data-v-03820f5f><a class="VPLink link vp-external-link-icon pager-link prev" href="https://chatgpt.com/?model=gpt-4&hints=search&prompt=You+are+a+JavaScript+expert+assistant.+Read+the+entire+content+from+the+following+URL%3A%0A%0Ahttps%3A%2F%2Faxios-cache-interceptor.js.org%2Fllms-full.txt%0AYou+are+free+to+follow+any+links+in+the+document+to+gather+more+information%2C+if+necessary.%0A%0AThe+document+is+a+comprehensive+guide+to+the+%60axios-cache-interceptor%60+library%2C+which+is+used+for+caching+HTTP+requests+in+Axios.%0A%0A**Your+task+is+to%3A**%0A%0A1.+Understand+the+purpose+and+functionality+of+the+library.%0A2.+Learn+the+key+concepts%2C+configuration+options%2C+and+API+methods+described.%0A3.+Retain+information+about+advanced+features%2C+usage+examples%2C+and+edge+cases.%0A4.+Be+ready+to+answer+technical+questions+or+explain+how+to+use+the+library%2C+troubleshoot+common+issues%2C+and+compare+it+with+other+caching+approaches+in+Axios.%0A%0ADo+not+summarize+yet.+Just+read+and+prepare+to+answer+detailed+questions." target="_blank" rel="noreferrer" data-v-03820f5f><!--[--><span class="desc" data-v-03820f5f>Previous page</span><span class="title" data-v-03820f5f>Ask ChatGPT</span><!--]--></a></div><div class="pager" data-v-03820f5f><a class="VPLink link pager-link next" href="/guide/getting-started" data-v-03820f5f><!--[--><span class="desc" data-v-03820f5f>Next page</span><span class="title" data-v-03820f5f>Getting Started</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-de37206a data-v-80957399><div class="container" data-v-80957399><p class="message" data-v-80957399>Made with ❤️</p><p class="copyright" data-v-80957399>Copyright (c) 2021-present Arthur Fiorette & Contributors</p></div></footer><!--[--><!--]--></div></div>
|
||
<script>window.__VP_HASH_MAP__=JSON.parse("{\"config.md\":\"CScI-ExK\",\"config_request-specifics.md\":\"B6wvTu18\",\"config_response-object.md\":\"8qsMplLz\",\"generated_benchmark.md\":\"DZpgBPX8\",\"guide.md\":\"Ch_3Blm4\",\"guide_comparison.md\":\"CJjCfmUB\",\"guide_debugging.md\":\"UDhonkLW\",\"guide_getting-started.md\":\"X7rsi6EE\",\"guide_interceptors.md\":\"B6YE2URo\",\"guide_invalidating-cache.md\":\"D69gSzWZ\",\"guide_request-id.md\":\"BqDUl7YS\",\"guide_storages.md\":\"mDfw43wo\",\"index.md\":\"Cj5fvPtr\",\"others_changelog.md\":\"DFW69MVv\",\"others_license.md\":\"Ceq08JKB\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Axios Cache Interceptor\",\"description\":\"Small and efficient cache interceptor for axios. Etag, Cache-Control, TTL, HTTP headers and more!\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/rocket.svg\",\"socialLinks\":[{\"icon\":\"discord\",\"link\":\"https://axios-cache-interceptor.js.org/discord\"},{\"icon\":\"github\",\"link\":\"https://github.com/arthurfiorette/axios-cache-interceptor\"},{\"icon\":{\"svg\":\"<svg xmlns=\\\"http://www.w3.org/2000/svg\\\" role=\\\"img\\\" viewBox=\\\"0 0 24 24\\\"><title>npm</title><path d=\\\"M1.763 0C.786 0 0 .786 0 1.763v20.474C0 23.214.786 24 1.763 24h20.474c.977 0 1.763-.786 1.763-1.763V1.763C24 .786 23.214 0 22.237 0zM5.13 5.323l13.837.019-.009 13.836h-3.464l.01-10.382h-3.456L12.04 19.17H5.113z\\\"/></svg>\"},\"link\":\"https://npmjs.com/package/axios-cache-interceptor\"},{\"icon\":{\"svg\":\"<svg xmlns=\\\"http://www.w3.org/2000/svg\\\" role=\\\"img\\\" viewBox=\\\"0 0 24 24\\\"><title>jsDelivr</title><path d=\\\"M11.851 0L.811 4.02l1.56 14.7L11.85 24l9.6-5.28 1.74-14.76zm.062 4.622a6.668 6.75 0 0 1 2.666.572 12.507 12.507 0 0 0-2.59 1.95c-.045-.02-.092-.031-.138-.045a1.181 1.181 0 0 0-.346-.056c-.071 0-.141.01-.21.021a8.91 8.91 0 0 1-.615-2.318 6.668 6.75 0 0 1 1.171-.122 6.668 6.75 0 0 1 .062-.002zm-1.99.312a9.763 9.763 0 0 0 .69 2.504 1.213 1.213 0 0 0-.328.825 1.202 1.202 0 0 0 .18.63c-.937 1.294-1.656 2.803-1.905 4.31-.01.056-.013.11-.02.166-.282.09-.515.284-.656.54-.987-.333-1.885-.968-2.615-2.022a6.668 6.75 0 0 1-.026-.515 6.668 6.75 0 0 1 4.68-6.438zm5.507.709a6.668 6.75 0 0 1 2.53 2.9c-.377.953-1.049 1.892-1.893 2.727a1.242 1.242 0 0 0-.644-.184 1.243 1.243 0 0 0-.768.27c-.462-.354-.91-.737-1.318-1.168-.333-.35-.637-.73-.921-1.123.19-.215.31-.494.31-.802 0-.212-.061-.41-.159-.586 1.058-1.008 2.112-1.67 2.863-2.034zm-3.925 1.982a.624.624 0 0 1 .346.114.624.624 0 0 1 .292.524.624.624 0 0 1-.292.524.626.626 0 0 1-.346.113.634.634 0 0 1-.638-.637c0-.355.283-.638.638-.638zm-.441 1.771a1.205 1.205 0 0 0 .675.062c.036.05.075.097.112.148a11.438 11.438 0 0 0 .921 1.119 12.103 12.103 0 0 0 1.446 1.277c-.032.11-.054.224-.054.342a1.236 1.236 0 0 0 .066.38 9.91 9.91 0 0 1-2.118 1.042c-.087.029-.173.052-.261.078a7.735 7.735 0 0 1-1.87.332 1.15 1.15 0 0 0-.66-.773c.004-.024.005-.049.01-.073.219-1.333.873-2.73 1.733-3.934zm7.272.19a6.668 6.75 0 0 1 .245 1.786 6.668 6.75 0 0 1-.259 1.856 9.993 9.993 0 0 1-1.666-.63 1.243 1.243 0 0 0-.065-.713 9.434 9.434 0 0 0 1.745-2.3zm-2.913 2.101c.367 0 .657.291.657.658s-.291.657-.657.657c-.367 0-.658-.29-.658-.657s.29-.658.658-.658zm.837 1.59a10.79 10.79 0 0 0 1.802.688 6.668 6.75 0 0 1-6.149 4.157 6.668 6.75 0 0 1-.062-.004 6.668 6.75 0 0 1-.042 0c-.087-.042-.168-.08-.266-.129-.312-.154-.667-.352-.846-.5a3.796 3.796 0 0 1-1.294-2.03c.21-.111.38-.284.487-.495a8.428 8.428 0 0 0 1.96-.306 9.11 9.11 0 0 0 .513-.154 11.083 11.083 0 0 0 2.341-1.13c.205.143.452.23.719.23a1.248 1.248 0 0 0 .837-.328zm-10.707.116a5.761 5.761 0 0 0 2.212 1.298 1.146 1.146 0 0 0 .857.87 4.602 4.602 0 0 0 1.24 2.222 6.668 6.75 0 0 1-4.31-4.39zm3.327.464c.331 0 .595.263.595.596s-.264.595-.595.595a.59.59 0 0 1-.596-.595.591.591 0 0 1 .596-.596z\\\"/></svg>\"},\"link\":\"https://www.jsdelivr.com/package/npm/axios-cache-interceptor\"}],\"nav\":[{\"text\":\"Guide\",\"link\":\"/guide\"},{\"text\":\"Config\",\"link\":\"/config\"},{\"text\":\"Others\",\"link\":\"/others/license\"},{\"text\":\"Latest\",\"items\":[{\"text\":\"v0.x\",\"link\":\"https://axios-cache-interceptor.js.org/v0/\"}]}],\"editLink\":{\"pattern\":\"https://github.com/arthurfiorette/axios-cache-interceptor/edit/main/docs/src/:path\"},\"footer\":{\"message\":\"Made with ❤️\",\"copyright\":\"Copyright (c) 2021-present Arthur Fiorette & Contributors\"},\"search\":{\"provider\":\"algolia\",\"options\":{\"appId\":\"WPY8IFS0UX\",\"apiKey\":\"8cc9e4ff3f98b5854346224aac791bbf\",\"indexName\":\"axios-cache-interceptor-js\"}},\"carbonAds\":{\"code\":\"CEBDT27Y\",\"placement\":\"vuejsorg\"},\"sidebar\":[{\"text\":\"Ask ChatGPT\",\"link\":\"https://chatgpt.com/?model=gpt-4&hints=search&prompt=You+are+a+JavaScript+expert+assistant.+Read+the+entire+content+from+the+following+URL%3A%0A%0Ahttps%3A%2F%2Faxios-cache-interceptor.js.org%2Fllms-full.txt%0AYou+are+free+to+follow+any+links+in+the+document+to+gather+more+information%2C+if+necessary.%0A%0AThe+document+is+a+comprehensive+guide+to+the+%60axios-cache-interceptor%60+library%2C+which+is+used+for+caching+HTTP+requests+in+Axios.%0A%0A**Your+task+is+to%3A**%0A%0A1.+Understand+the+purpose+and+functionality+of+the+library.%0A2.+Learn+the+key+concepts%2C+configuration+options%2C+and+API+methods+described.%0A3.+Retain+information+about+advanced+features%2C+usage+examples%2C+and+edge+cases.%0A4.+Be+ready+to+answer+technical+questions+or+explain+how+to+use+the+library%2C+troubleshoot+common+issues%2C+and+compare+it+with+other+caching+approaches+in+Axios.%0A%0ADo+not+summarize+yet.+Just+read+and+prepare+to+answer+detailed+questions.\",\"target\":\"_blank\"},{\"text\":\"Guide\",\"items\":[{\"text\":\"Introduction\",\"link\":\"/guide\"},{\"text\":\"Getting Started\",\"link\":\"/guide/getting-started\"},{\"text\":\"Debugging\",\"link\":\"/guide/debugging\"},{\"text\":\"Storages\",\"link\":\"/guide/storages\"},{\"text\":\"Request Id\",\"link\":\"/guide/request-id\"},{\"text\":\"Invalidating Cache\",\"link\":\"/guide/invalidating-cache\"},{\"text\":\"Comparison\",\"link\":\"/guide/comparison\"},{\"text\":\"Other Interceptors\",\"link\":\"/guide/interceptors\"}]},{\"text\":\"Config\",\"items\":[{\"text\":\"Global Configuration\",\"link\":\"/config\"},{\"text\":\"Request Specifics\",\"link\":\"/config/request-specifics\"},{\"text\":\"Response Object\",\"link\":\"/config/response-object\"}]},{\"text\":\"MIT License\",\"link\":\"/others/license\"},{\"text\":\"Changelog\",\"link\":\"/others/changelog\"},{\"text\":\"llms.txt\",\"link\":\"/llms.txt\"},{\"text\":\"llms-full.txt\",\"link\":\"/llms-full.txt\"}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
|
||
|
||
</body>
|
||
</html> |