BackgroundFetchRegistration: matchAll() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The matchAll()
method of the BackgroundFetchRegistration
interface returns an array of matching BackgroundFetchRecord
objects.
Syntax
js
matchAll(request)
matchAll(request,options)
Parameters
request
-
The
Request
for which you are attempting to find records. This can be aRequest
object or a URL. options
Optional-
An object that sets options for the
match
operation. The available options are:ignoreSearch
-
A boolean value that specifies whether to ignore the query string in the URL. For example, if set to
true
the?value=bar
part ofhttp://foo.com/?value=bar
would be ignored when performing a match. It defaults tofalse
. ignoreMethod
-
A boolean value. When
true
, prevents matching operations from validating theRequest
http
method. Iffalse
(the default) onlyGET
andHEAD
are allowed. ignoreVary
-
A boolean value. When
true
indicates that theVARY
header should be ignored. It defaults tofalse
.
Return value
A Promise
that resolves with an array of all matching BackgroundFetchRecord
objects.
Exceptions
InvalidStateError
DOMException
-
Returned if the
recordsAvailable
flag isfalse
, indicating that there is no fetch in progress.
Examples
Use matchAll()
with no parameters to return all of the records in a background fetch.
js
const records = await bgFetch.matchAll();
console.log(records); // an array of BackgroundFetchRecord objects
Specifications
Specification |
---|
Background Fetch # background-fetch-registration-match-all |
Browser compatibility
BCD tables only load in the browser