CacheStorage

The CacheStorage interface represents the storage for Cache (en-US) objects.

The interface:

Use CacheStorage.open() (en-US) to obtain a Cache (en-US) instance.

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

You can access CacheStorage through the global caches (en-US) 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() (en-US) is a convenience method. Equivalent functionality to match a cache entry can be implemented by returning an array of cache names from CacheStorage.keys() (en-US), opening each cache with CacheStorage.open() (en-US), and matching the one you want with Cache.match() (en-US).

Methods

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

Examples

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

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

  1. Check whether a match for the request is found in the CacheStorage. If so, serve that.
  2. 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 (en-US) (cache.put(event.request, response.clone()).)
  3. 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 (en-US).

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 Workers
The definition of 'CacheStorage' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser

See also