CookieStore.getAll()
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
CookieStore
インターフェイスの getAll()
メソッドは、渡された名前またはオプションに一致する Cookie のリストを返します。パラメータを何も渡さなければ、現在のコンテキストのすべての Cookie を返します。
構文
var list = cookieStore.getAll(name);
var list = cookieStore.getAll(options);
引数
name
省略可-
Cookie の名前が入っている
USVString
です。 options
省略可-
An object containing:
メモ: url
オプションは、特定の URL をスコープとした Cookie の変更を可能にします。サービスワーカーは、自分のスコープ下にある任意の URL に送信される Cookie を取得できます。ドキュメントからは現在の URL の Cookie しか取得できないので、ドキュメントコンテキストで有効な URL はドキュメントの URL のみとなります。
返値
与えられた名前またはオプションの Cookie のリストに解決される Promise
です。
例外
TypeError
-
与えられた
name
やoptions
で表される Cookie の取得に失敗した場合にスローされます。
例
この例では、引数無しで getAll()
を使用しています。このコンテキストのすべての Cookie をオブジェクトの配列として返します。
let cookies = cookieStore.getAll();
if (cookies) {
console.log(cookies);
} else {
console.log('Cookie not found');
}
仕様書
Specification |
---|
Cookie Store API # dom-cookiestore-getall |
ブラウザーの互換性
BCD tables only load in the browser