CookieStore

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

Cookie Store API (en-US) のインターフェイスである CookieStore は、ページまたはサービスワーカーから非同期に Cookie を取得、設定するためのメソッドを提供します。

CookieStore は Window or ServiceWorkerGlobalScope コンテキスト内のグローバスコープの属性を介してアクセスされます。そのため、コンストラクタはありません。

メソッド

CookieStore.delete(): delete() メソッドは与えられた名前またはオプションオブジェクトを持つ Cookie を削除します。削除が完了すると解決される Promise が返されます。
CookieStore.get(): get() メソッドは与えられた名前またはオプションオブジェクトで 1 つの Cookie を取得します。1 つの Cookie の詳細に解決される Promise を返します。
CookieStore.getAll(): getAll() メソッドはマッチするすべての Cookie を取得します。Cookie のリストに解決される Promise を返します。
CookieStore.set(): set() メソッドは与えられた名前と値またはオプションオブジェクトを Cookie に設定し、Cookie が設定されると解決される Promise を返します。

イベント

CookieStore.change_event: change イベントは、任意の Cookie に変更が加えられたときに発生します。

例

この例では、Cookie を設定し、操作が成功したか失敗したかのフィードバックをコンソールに書き込んでいます。

const day = 24 * 60 * 60 * 1000;
cookieStore.set({
  name: "cookie1",
  value: "cookie1-value",
  expires: Date.now() + day,
  domain: "example.com"
})
.then(
  function() {
    console.log("It worked!");
  },
  function(reason) {
    console.error("It failed: ", reason);
  }
);

仕様書

Specification
Cookie Store API # CookieStore

ブラウザーの互換性

BCD tables only load in the browser