Cache: match() method
Service Workers API
Service Workers API
The match() method of the Cache interface returns a Promise that resolves to the Response associated with the first matching request in the Cache object.
If no match is found, the Promise resolves to undefined.
Syntax
match(request)
match(request, options)
Parameters
request- : The Request for which you are attempting to find responses in the Cache. This can be a Request object or a URL string.
options- : An object that sets options for the
matchoperation. The available options are:ignoreSearch- : A boolean value that specifies whether to
ignore the query string in the URL. For example, if set to
truethe?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 whether the Response object has aVARYheader. It defaults tofalse.
Return value
A Promise that resolves to the first Response that matches the request or to undefined if no match is found.
[!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
This example is taken from the custom offline page example (live demo). It uses a cache to supply selected data when a request fails. A
catch() clause is triggered when the call to fetch() throws an
exception. Inside the catch() clause, match() is used to
return the correct response.
In this example, only HTML documents retrieved with the GET HTTP verb will be
cached. If our if () condition is false, then this fetch handler won't
intercept the request. If there are any other fetch handlers registered, they will get a
chance to call event.respondWith(). If no fetch handlers call
event.respondWith(), the request will be handled by the browser as if there
were no service worker involvement. If fetch() returns a valid HTTP
response with a response code in the 4xx or 5xx range, the catch() will
NOT be called.
self.addEventListener("fetch", (event) => {
// We only want to call event.respondWith() if this is a GET request for an HTML document.
if (
event.request.method === "GET" &&
event.request.headers.get("accept").includes("text/html")
) {
console.log("Handling fetch event for", event.request.url);
event.respondWith(
fetch(event.request).catch((e) => {
console.error("Fetch failed; returning offline page instead.", e);
return caches
.open(OFFLINE_CACHE)
.then((cache) => cache.match(OFFLINE_URL));
}),
);
}
});
Specifications
Browser compatibility
See also
- Using Service Workers
- Cache
- Window.caches and WorkerGlobalScope.caches