Cache.addAll()
This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.
Summary
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 have newer language stating 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.
Note: As of Chrome 46, the Cache API will only store requests from secure origins, meaning those served over HTTPS.
Syntax
cache.addAll(requests[]).then(function() { //requests have been added to the cache });
Parameters
- requests
- An array of
Request
objects you want to add to the cache.
Returns
A Promise
that resolves with void.
Exceptions
Exception | Happens when |
---|---|
TypeError |
The URL scheme is not 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. |
Working Draft | Initial definition. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | 46.0 | (Yes)[1] | No support | 24 | No support |
Require HTTPS | 46.0 | (Yes)[1] | ? | ? | ? |
TypeError if request is not successful |
(Yes) | 47.0 (47.0)[1] | (Yes) | (Yes) | (Yes) |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|---|
Basic support | No support | No support | (Yes) | ? | No support | ? | No support | 46.0 |
Require HTTPS | No support | No support | (Yes) | ? | ? | ? | ? | 46.0 |
TypeError if request is not successful |
(Yes) | (Yes) | (Yes) | (Yes) | (Yes) | (Yes) | (Yes) | (Yes) |
[1] Service workers (and Push) have been disabled in the Firefox 45 Extended Support Release (ESR.)
See also
License
© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/cache/addall