Cache.keys()
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
});
Parameters
- request Optional
-
The
Request
want to return, if a specific key is desired. This can be aRequest
object or a URL. - options Optional
-
An object whose properties control how matching is done in the
keys
operation. The available options are:-
ignoreSearch
: A boolean value 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
: A boolean value that, when set totrue
, prevents matching operations from validating theRequest
HTTP
method (normally onlyGET
andHEAD
are allowed.) It defaults tofalse
. -
ignoreVary
: A boolean value 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()
.
-
Return value
Examples
caches.open('v1').then(function(cache) {
cache.keys().then(function(keys) {
keys.forEach(function(request, index, array) {
cache.delete(request);
});
});
})
Specifications
Specification |
---|
Service Workers 1 # cache-keys |
Browser compatibility
BCD tables only load in the browser