This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The put() method of the Cache interface allows key/value pairs to be added to the current Cache object.

Often, you will just want to fetch() one or more requests, then add the result straight to your cache. In such cases you are better off using Cache.add()/Cache.addAll(), as they are shorthand functions for one or more of these operations.

fetch(url).then(function(response) {
  if (!response.ok) {
    throw new TypeError('Bad response status');
  }
  return cache.put(url, response);
})

Note: put() will overwrite any key/value pair previously stored in the cache that matches the request.

Note: Cache.add/Cache.addAll do not cache responses with Response.status values that are not in the 200 range, whereas Cache.put lets you store any request/response pair. As a result, Cache.add/Cache.addAll can't be used to store opaque responses, whereas Cache.put can.

Note: Initial Cache implementations (in both Blink and Gecko) resolve Cache.add, Cache.addAll, and Cache.put promises when the response body is fully written to the disk.  More recent spec versions state that the browser can resolve the promise as soon as the entry is recorded in the database even if the response body is still streaming in.

Syntax

cache.put(request, response).then(function() {
  // request/response pair has been added to the cache
});

Parameters

request
The Request you want to add to the cache.
response
The Response you want to match up to the request.

Return value

A Promise that resolves with void.

Note: The promise will reject with a TypeError if the URL scheme is not http or https.

Examples

This example is from the MDN sw-test example (see sw-test running live). Here we wait for a FetchEvent to fire. We construct a custom response like so:

  1. Check whether a match for the request is found in the CacheStorage using CacheStorage.match(). If so, serve that.
  2. If not, open the v1 cache using open(), put the default network request in the cache using Cache.put() and return a clone of the default network request using return response.clone(). Clone is needed because put() consumes the response body.
  3. If this fails (e.g., because the network is down), return a fallback response.
var response;
var cachedResponse = caches.match(event.request).catch(function() {
  return fetch(event.request);
}).then(function(r) {
  response = r;
  caches.open('v1').then(function(cache) {
    cache.put(event.request, response);
  });  
  return response.clone();
}).catch(function() {
  return caches.match('/sw-test/gallery/myLittleVader.jpg');
});

Specifications

Specification Status Comment
Service Workers
The definition of 'Cache' in that specification.
Working Draft Initial definition.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
Experimental
Chrome Full support 43
Notes
Full support 43
Notes
Notes Requires HTTPS from version 46.
Edge Full support 16Firefox Full support 39
Notes
Full support 39
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE No support NoOpera Full support 30
Notes
Full support 30
Notes
Notes Requires HTTPS from version 33.
Safari No support NoWebView Android Full support 43
Notes
Full support 43
Notes
Notes Requires HTTPS from version 46.
Chrome Android Full support 43
Notes
Full support 43
Notes
Notes Requires HTTPS from version 46.
Edge Mobile No support NoFirefox Android Full support 39Opera Android Full support 30
Notes
Full support 30
Notes
Notes Requires HTTPS from version 33.
Safari iOS No support NoSamsung Internet Android Full support 4.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.

See also

Document Tags and Contributors

Last updated by: ronyclau,