Cache.add()

The add() method of the Cache interface takes a URL, retrieves it, and adds the resulting response object to the given cache.

The add() method is functionally equivalent to the following:

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

For more complex operations, you'll need to use Cache.put() directly.

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

Syntax

cache.add(request).then(function() {
  // request has been added to the cache
});

Parameters

request

The request you want to add to the cache. This can be a Request object or a URL.

Return value

A Promise that resolves with undefined.

Exceptions

TypeError

The URL scheme is not http or https.

The Response status is not in the 200 range (i.e., not a successful response.) This occurs if the request does not return successfully, but also if the request is a cross-origin no-cors request (in which case the reported status is always 0.)

Examples

This code block waits for an InstallEvent to fire, then calls waitUntil() to handle the install process for the app. This consists of calling CacheStorage.open to create a new cache, then using Cache.add to add an asset to it.

this.addEventListener('install', function(event) {
  event.waitUntil(
    caches.open('v1').then(function(cache) {
      return cache.add('/sw-test/index.html');
    })
  );
});

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
add
44
Requires HTTPS from version 46.
16
39
Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
No
31
Requires HTTPS from version 33.
11
44
Requires HTTPS from version 46.
44
Requires HTTPS from version 46.
39
32
Requires HTTPS from version 33.
11
4.0
Requires HTTPS from Samsung Internet 5.0.

See also

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Cache/add