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

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: A Boolean that specifies whether the matching process should ignore the query string in the url.  If set to true, the ?value=bar part of http://foo.com/?value=bar would be ignored when performing a match. It defaults to false.
  • ignoreMethod: A Boolean that, when set to true, prevents matching operations from validating the Request HTTP method (normally only GET and HEAD are allowed.) It defaults to false.
  • ignoreVary: A Boolean that, when set to true, tells the matching operation not to perform VARY header matching.  In other words, if the URL matches you will get a match regardless of  whether the Response object has a VARY header. It defaults to false.
  • cacheName: A DOMString that represents a specific cache to search within. Note that this option is ignored by Cache.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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
Experimental
Chrome Full support 43Edge 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 30Safari No support NoWebView Android Full support 43Chrome Android Full support 43Edge Mobile No support NoFirefox Android Full support 39Opera Android Full support 30Safari 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: fscholz,