BackgroundFetchRegistration.matchAll()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

BackgroundFetchRegistration インターフェイスの matchAll() メソッドは、マッチする BackgroundFetchRecord オブジェクトの配列を返します。

構文

js
matchAll(request)
matchAll(request,options)

引数

request

取得したい record の Request。これは Request オブジェクトまたは URL です。

options 省略可

match 操作のオプションを指定するオブジェクトです。以下が利用可能です。

ignoreSearch

URL 中のクエリー文字列を無視するかどうか指定するbool 値です。例えば true のとき、http://foo.com/?value=bar?value=bar 部分はマッチ処理で無視されます。デフォルトは false です。

ignoreMethod

bool 値です。true のとき、マッチ処理は Requesthttp メソッドを検証しません。false (デフォルト値)の場合、GETHEAD のみ許可されます。

ignoreVary

bool 値です。trueVARY ヘッダーを無視することを意味します。デフォルトは false です。

返値

マッチした全ての BackgroundFetchRecord オブジェクトの配列で解決される Promise を返します。

例外

InvalidStateError DOMException

recordsAvailable フラグが false のとき、発生します。 これは、進行中のフェッチが存在しないことを意味します。

matchAll() を引数なしで呼び出すことで、バックグラウンドフェッチの全ての record を取得することができます。

js
const records = await bgFetch.matchAll();
console.log(records); // BackgroundFetchRecord オブジェクトの配列

仕様書

Specification
Background Fetch
# background-fetch-registration-match-all

ブラウザーの互換性

BCD tables only load in the browser