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.
The keys()
method of the Cache
interface returns a Promise
that resolves to an array of Cache
keys.
The requests are returned in the same order that they were inserted.
Note: Requests with duplicate URLs but different headers can be returned if their responses have the VARY
header set on them.
Syntax
cache.keys(request,{options}).then(function(keys) { //do something with your array of requests });
Returns
A Promise
that resolves to an array of Cache
keys.
Parameters
- request Optional
- The
Request
want to return, if a specific key is desired. - options Optional
- An object whose properties control how matching is done in the
keys
operation. The available options are:ignoreSearch
: ABoolean
that specifies whether the matching process should ignore the query string in the url. If set totrue
, the?value=bar
part ofhttp://foo.com/?value=bar
would be ignored when performing a match. It defaults tofalse
.ignoreMethod
: ABoolean
that, when set totrue
, prevents matching operations from validating theRequest
HTTP
method (normally onlyGET
andHEAD
are allowed.) It defaults tofalse
.ignoreVary
: ABoolean
that, when set totrue,
tells the matching operation not to performVARY
header matching. In other words, if the URL matches you will get a match regardless of whether theResponse
object has aVARY
header. It defaults tofalse
.cacheName
: ADOMString
that represents a specific cache to search within. Note that this option is ignored byCache.keys()
.
Examples
caches.open('v1').then(function(cache) { cache.keys().then(function(keys) { keys.forEach(function(request, index, array) { cache.delete(request); }); }); })
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 | 40.0[1] | 39 (39)[2] | No support | 24 | No support |
All options supported | 54.0 | 41 |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|---|
Basic support | No support | No support | 39.0 (39) | ? | No support | (Yes) | No support | 40.0[1] |
All options supported | No support | No support | 41 | 54.0 |
[1] The options parameter only supports ignoreSearch
, and cacheName
.
[2] Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR.)