W3cubDocs

Cache.addAll

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

The addAll() method of the Cache interface takes an array of URLs, retrieves them, and adds the resulting response objects to the given cache. The request objects created during retrieval become keys to the stored response operations.

Note: addAll() will overwrite any key/value pairs previously stored in the cache that match the request, but will fail if a resulting put() operation would overwrite a previous cache entry created by the same addAll() method.

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 storage. 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.addAll(requests[]).then(function() {
  // requests have been added to the cache
});

Parameters

requests: An array of string URLs that you want to be fetched and added to the cache.

Return value

A Promise that resolves with void.

Exceptions

Exception Happens when

Exception	Happens when
`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.)

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 runs waitUntil() to handle the install process for the app. This consists of calling CacheStorage.open to create a new cache, then using addAll() to add a series of assets to it.

this.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/',
        '/sw-test/gallery/bountyHunters.jpg',
        '/sw-test/gallery/myLittleVader.jpg',
        '/sw-test/gallery/snowTroopers.jpg'
      ]);
    })
  );
});

Specifications

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

Browser compatibility

Feature	Chrome	Edge	Firefox (Gecko)	Internet Explorer	Opera	Safari (WebKit)
Basic support	46	(Yes)	(Yes)^[1]	No support	33	No support
Require HTTPS	46	(Yes)	(Yes)^[1]	?	33	?
`TypeError` if request is not successful	46	?	47.0 (47.0)^[1]	(Yes)	(Yes)	(Yes)

Feature	Android Webview	Chrome for Android	Firefox Mobile (Gecko)	Firefox OS	IE Mobile	Opera Mobile	Safari Mobile
Basic support	46	46	(Yes)	?	No support	33	No support
Require HTTPS	46	46	(Yes)	?	?	33	?
`TypeError` if request is not successful	(Yes)	(Yes)	(Yes)	(Yes)	(Yes)	(Yes)	(Yes)

[1] Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR.)

Cache.addAll

Syntax

Parameters

Return value

Exceptions

Examples

Specifications

Browser compatibility

See also