docs: updated readme example

arthurfiorette · Sep 11, 2021 · aa83c24 · aa83c24
1 parent 0d4854d
commit aa83c24
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -67,16 +67,22 @@ import { createCache, SessionCacheStorage } from 'axios-cache-interceptor';
 const api = axios.create();
 
 // Other axios instance with caching enabled
-const cache = createCache(api, {
+const cachedApi = createCache(api, {
   // Store values on window.sessionStorage
   storage: new SessionCacheStorage(),
 
   // Use the max-age header to determine the cache expiration time
   interpretHeader: true
 });
 
-// Exactly the same as before
-cache.get('http://example.com/');
+// Make a requests that's only cached if the response comes with success header
+cachedApi.get('http://example.com/', {
+  cache: {
+    cachePredicate: {
+      containsHeaders: ['success']
+    }
+  }
+});
 ```
 
 <br />

diff --git a/docs/readme.ts → docs/readme-example.ts b/docs/readme.ts → docs/readme-example.ts
@@ -7,13 +7,19 @@ import { createCache, SessionCacheStorage } from '../src/index';
 const api = axios.create();
 
 // Other axios instance with caching enabled
-const cache = createCache(api, {
+const cachedApi = createCache(api, {
   // Store values on window.sessionStorage
   storage: new SessionCacheStorage(),
 
   // Use the max-age header to determine the cache expiration time
   interpretHeader: true
 });
 
-// Exactly the same as before
-cache.get('http://example.com/');
+// Make a requests that's only cached if the response comes with success header
+cachedApi.get('http://example.com/', {
+  cache: {
+    cachePredicate: {
+      containsHeaders: ['success']
+    }
+  }
+});