Background Fetch API
The match() method of the BackgroundFetchRegistration interface returns the first matching BackgroundFetchRecord.
Syntax
match(request)
match(request, options)
Parameters
request- : The Request for which you are attempting to find records. This can be a Request object or a URL.
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.
- : A boolean value that specifies whether to
ignore the query string in the URL. For example, if set to
ignoreMethod- : A boolean value. When
true, prevents matching operations from validating the Requesthttpmethod. Iffalse(the default) onlyGETandHEADare allowed.
- : A boolean value. When
ignoreVary- : A boolean value. When
trueindicates that the Vary header should be ignored. It defaults tofalse.
- : A boolean value. When
- : An object that sets options for the
Return value
A Promise that resolves with the first BackgroundFetchRecord that matches the request or undefined if no match is found.
[!NOTE]
BackgroundFetchRegistration.match()is basically identical to BackgroundFetchRegistration.matchAll(), except that rather than resolving with an array of all matching records, it resolves with the first matching record only.
Exceptions
InvalidStateErrorDOMException- : Returned if you call
match()when there are no fetches in progress. This state will be reflected by BackgroundFetchRegistration.recordsAvailable being set tofalse.
- : Returned if you call
Examples
In this example we look for a record with the URL "/ep-5.mp3". If a BackgroundFetchRecord is found then we can return some information about it.
bgFetch.match("/ep-5.mp3").then(async (record) => {
if (!record) {
console.log("No record found");
return;
}
console.log(`Here's the request`, record.request);
const response = await record.responseReady;
console.log(`And here's the response`, response);
});
Specifications
Browser compatibility
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
