BackgroundFetchRegistration: matchAll() method
Background Fetch API
Background Fetch API
The matchAll() method of the BackgroundFetchRegistration interface returns an array of matching BackgroundFetchRecord objects.
Syntax
matchAll()
matchAll(request)
matchAll(request,options)
Parameters
request- : The Request for which you are attempting to find records. This can be a Request object or a URL. If this parameter is omitted, all records are included in the result.
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. When
true, prevents matching operations from validating the Requesthttpmethod. Iffalse(the default) onlyGETandHEADare allowed. ignoreVary- : A boolean value. When
trueindicates that the Vary header should be ignored. It defaults tofalse.
Return value
A Promise that resolves with an array of all matching BackgroundFetchRecord objects.
Exceptions
InvalidStateErrorDOMException- : Returned if the recordsAvailable flag is
false, indicating that there is no fetch in progress.
Examples
Use matchAll() with no parameters to return all of the records in a background fetch.
const records = await bgFetch.matchAll();
console.log(records); // an array of BackgroundFetchRecord objects