Cache: matchAll() method
Service Workers API
Service Workers API
The matchAll() method of the Cache
interface returns a Promise that resolves to an array of all matching
responses in the Cache object.
Syntax
matchAll()
matchAll(request)
matchAll(request, options)
Parameters
request- : The Request for which you are attempting to find responses in the
Cache. This can be a
Requestobject or a URL. If this argument is omitted, you will get a copy of all responses in this cache. options- : An options object allowing you to set specific control options for the matching
performed. The available options are:
ignoreSearch- : A boolean value that specifies whether the
matching process should ignore the query string in the URL. If set to
true, the?value=barpart ofhttps://example.com/?value=barwould be ignored when performing a match. It defaults tofalse. ignoreMethod- : A boolean value that, when set to
true, prevents matching operations from validating the Requesthttpmethod (normally onlyGETandHEADare allowed.) It defaults tofalse. ignoreVary- : A boolean value that when set to
truetells the matching operation not to performVARYheader matching — i.e., if the URL matches you will get a match regardless of the Response object having aVARYheader or not. It defaults tofalse.
Return value
A Promise that resolves to an array of all matching responses in the Cache object.
[!NOTE] Cache.match() is basically identical to
Cache.matchAll(), except that rather than resolving with an array of all matching responses, it resolves with the first matching response only (that is,response[0]).
Examples
The following example retrieves all responses in the v1 cache matching the URL /, even including potential query parameters. By using { ignoreSearch: true }, using matchAll would retrieve / as well as /?value=bar.
It then logs the number of matching responses.
caches
.open("v1")
.then((cache) => cache.matchAll("/", { ignoreSearch: true }))
.then((responses) => {
console.log(`Found ${responses.length} matching responses`);
});
Specifications
Browser compatibility
See also
- Using Service Workers
- Cache
- Window.caches and WorkerGlobalScope.caches