Web/API/CacheStorage

The CacheStorage interface represents the storage for Cache objects.

The interface:

Provides a master directory of all the named caches that can be accessed by a ServiceWorker or other type of worker or window scope (you’re not limited to only using it with service workers, even though the Service Workers spec defines it).

Note: Chrome and Safari only expose `CacheStorage` to the windowed context over HTTPS. window.caches will be undefined unless an SSL certificate is configured.
Maintains a mapping of string names to corresponding Cache objects.

Use CacheStorage.open() to obtain a Cache instance.

Use CacheStorage.match() to check if a given Request is a key in any of the Cache objects that the CacheStorage object tracks.

You can access CacheStorage through the global caches property.

Note: CacheStorage always rejects with a SecurityError on untrusted origins (i.e. those that aren't using HTTPS, although this definition will likely become more complex in the future.) When testing, you can get around this by checking the "Enable Service Workers over HTTP (when toolbox is open)" option in the Firefox Devtools options/gear menu.

Note: CacheStorage.match() is a convenience method. Equivalent functionality to match a cache entry can be implemented by returning an array of cache names from CacheStorage.keys(), opening each cache with CacheStorage.open(), and matching the one you want with Cache.match().

Methods

CacheStorage.match(): Checks if a given Request is a key in any of the Cache objects that the CacheStorage object tracks, and returns a Promise that resolves to that match.
CacheStorage.has(): Returns a Promise that resolves to true if a Cache object matching the cacheName exists.
CacheStorage.open(): Returns a Promise that resolves to the Cache object matching the cacheName (a new cache is created if it doesn't already exist.)
CacheStorage.delete(): Finds the Cache object matching the cacheName, and if found, deletes the Cache object and returns a Promise that resolves to true. If no Cache object is found, it resolves to false.
CacheStorage.keys(): Returns a Promise that will resolve with an array containing strings corresponding to all of the named Cache objects tracked by the CacheStorage. Use this method to iterate over a list of all the Cache objects.

Examples

This code snippet is from the MDN sw-test example (see [[../../../../../../mdn.github.io/sw-test/index|sw-test running live]].) This service worker script waits for an InstallEvent to fire, then runs waitUntil to handle the install process for the app. This consists of calling CacheStorage.open to create a new cache, then using Cache.addAll to add a series of assets to it.

In the second code block, we wait for a FetchEvent to fire. We construct a custom response like so:

Check whether a match for the request is found in the CacheStorage. If so, serve that.
If not, fetch the request from the network, then also open the cache created in the first block and add a clone of the request to it using Cache.put (cache.put(event.request, response.clone()).)
If this fails (e.g. because the network is down), return a fallback response.

Finally, return whatever the custom response ended up being equal to, using FetchEvent.respondWith.

self.addEventListener('install', function(event) {
  event.waitUntil(
    caches.open('v1').then(function(cache) {
      return cache.addAll([
        '/sw-test/',
        '/sw-test/index.html',
        '/sw-test/style.css',
        '/sw-test/app.js',
        '/sw-test/image-list.js',
        '/sw-test/star-wars-logo.jpg',
        '/sw-test/gallery/bountyHunters.jpg',
        '/sw-test/gallery/myLittleVader.jpg',
        '/sw-test/gallery/snowTroopers.jpg'
      ]);
    })
  );
});

self.addEventListener('fetch', function(event) {
  event.respondWith(caches.match(event.request).then(function(response) {
    // caches.match() always resolves
    // but in case of success response will have value
    if (response !== undefined) {
      return response;
    } else {
      return fetch(event.request).then(function (response) {
        // response may be used only once
        // we need to save clone to put one copy in cache
        // and serve second one
        let responseClone = response.clone();
        
        caches.open('v1').then(function (cache) {
          cache.put(event.request, responseClone);
        });
        return response;
      }).catch(function () {
        return caches.match('/sw-test/gallery/myLittleVader.jpg');
      });
    }
  }));
});

This snippet shows how the API can be used outside of a service worker context, and uses the await operator for much more readable code.

// Try to get data from the cache, but fall back to fetching it live.
async function getData() {
   const cacheVersion = 1;
   const cacheName    = `myapp-${ cacheVersion }`;
   const url          = 'https://jsonplaceholder.typicode.com/todos/1';
   let cachedData     = await getCachedData( cacheName, url );

   if ( cachedData ) {
      console.log( 'Retrieved cached data' );
      return cachedData;
   }

   console.log( 'Fetching fresh data' );

   const cacheStorage = await caches.open( cacheName );
   await cacheStorage.add( url );
   cachedData = await getCachedData( cacheName, url );
   await deleteOldCaches( cacheName );

   return cachedData;
}

// Get data from the cache.
async function getCachedData( cacheName, url ) {
   const cacheStorage   = await caches.open( cacheName );
   const cachedResponse = await cacheStorage.match( url );

   if ( ! cachedResponse || ! cachedResponse.ok ) {
      return false;
   }

   return await cachedResponse.json();
}

// Delete any old caches to respect user's disk space.
async function deleteOldCaches( currentCache ) {
   const keys = await caches.keys();

   for ( const key of keys ) {
      const isOurCache = 'myapp-' === key.substr( 0, 6 );

      if ( currentCache === key || ! isOurCache ) {
         continue;
      }

      caches.delete( key );
   }
}

try {
   const data = await getData();
   console.log( { data } );
} catch ( error ) {
   console.error( { error } );
}

Specifications

Specification	Status	Comment
Service WorkersThe definition of 'CacheStorage' in that specification.	Working Draft	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`CacheStorage` Experimental'	Chrome Full support 40 Notes' Full support 40 Notes' Notes' Accessible from `Window` from version 43. Notes' Accessible from `WorkerGlobalScope` from version 43.	Edge Full support ≤18	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 27	Safari Full support 11.1	WebView Android Full support 40 Notes' Full support 40 Notes' Notes' Accessible from `Window` from version 43. Notes' Accessible from `WorkerGlobalScope` from version 43.	Chrome Android Full support 40 Notes' Full support 40 Notes' Notes' Accessible from `Window` from version 43. Notes' Accessible from `WorkerGlobalScope` from version 43.	Firefox Android Full support 44	Opera Android Full support 27	Safari iOS Full support 11.3	Samsung Internet Android Full support 4.0 Notes' Full support 4.0 Notes' Notes' Accessible from `Window` from Samsung Internet 4.0. Notes' Accessible from `WorkerGlobalScope` from Samsung Internet 4.0.
`delete` Experimental'	Chrome Full support 40	Edge Full support 16	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 27	Safari Full support 11.1	WebView Android Full support 40	Chrome Android Full support 40	Firefox Android Full support 44	Opera Android Full support 27	Safari iOS Full support Yes	Samsung Internet Android Full support 4.0
`has` Experimental'	Chrome Full support 40	Edge Full support 16	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 27	Safari Full support 11.1	WebView Android Full support 40	Chrome Android Full support 40	Firefox Android Full support 44	Opera Android Full support 27	Safari iOS Full support Yes	Samsung Internet Android Full support 4.0
`keys` Experimental'	Chrome Full support 40	Edge Full support 16	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 27	Safari Full support 11.1	WebView Android Full support 40	Chrome Android Full support 40	Firefox Android Full support 44	Opera Android Full support 27	Safari iOS Full support Yes	Samsung Internet Android Full support 4.0
`match` Experimental'	Chrome Full support 54 Full support 54 Partial support 40 Notes' Notes' The options parameter only supports `ignoreSearch`, and `cacheName`.	Edge Full support 16	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 41 Full support 41 Partial support 27 Notes' Notes' The options parameter only supports `ignoreSearch`, and `cacheName`.	Safari Full support 11.1	WebView Android Full support 54 Full support 54 Partial support 40 Notes' Notes' The options parameter only supports `ignoreSearch`, and `cacheName`.	Chrome Android Full support 54 Full support 54 Partial support 40 Notes' Notes' The options parameter only supports `ignoreSearch`, and `cacheName`.	Firefox Android Full support 44	Opera Android Full support 41 Full support 41 Partial support 27 Notes' Notes' The options parameter only supports `ignoreSearch`, and `cacheName`.	Safari iOS Full support Yes	Samsung Internet Android Full support 6.0 Full support 6.0 Partial support 4.0 Notes' Notes' The options parameter only supports `ignoreSearch`, and `cacheName`.
`open` Experimental'	Chrome Full support 40	Edge Full support 16	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 27	Safari Full support 11.1	WebView Android Full support 40	Chrome Android Full support 40	Firefox Android Full support 44	Opera Android Full support 27	Safari iOS Full support Yes	Samsung Internet Android Full support 4.0
Secure context required Experimental'	Chrome Full support 65	Edge Full support ≤79	Firefox Full support 44	IE No support No	Opera Full support 52	Safari Full support Yes	WebView Android Full support 65	Chrome Android Full support 65	Firefox Android Full support 44	Opera Android Full support 47	Safari iOS Full support Yes	Samsung Internet Android Full support 9.0

Legend

Full support: Full support
No support: No support
Experimental. Expect behavior to change in the future.': Experimental. Expect behavior to change in the future.
See implementation notes.': See implementation notes.