CookieChangeEvent

Limited availability

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

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

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

「Cookie Store API」の CookieChangeEvent インターフェイスは、Cookie が何か変更された時 CookieStore で発火する change イベントのイベント型です。Cookie の変更は、Cookie と種類 ("changed" または "deleted") からなります。

CookieChangeEvent を発生させる Cookie の変更は、以下のものがあります。

  • Cookie が新規作成され、すぐには削除されません。この場合の type は "changed" です。
  • Cookie が新規作成され、すぐに削除されます。この場合の type は "deleted" です。
  • Cookie が削除されます。この場合の type は "deleted" です。

メモ: 同じ名前・ドメイン・パスの他の Cookie が挿入されることにより置き換えられる Cookie は無視され、変更イベントを発生させません。

Event CookieChangeEvent

コンストラクター

CookieChangeEvent()

新しい CookieChangeEvent を生成します。

インスタンスプロパティ

このインターフェイスは、Event からもプロパティを継承します。

CookieChangeEvent.changed 読取専用

1 個以上の変更された Cookie が格納された配列を返します。

CookieChangeEvent.deleted 読取専用

1 個以上の削除された Cookie が格納された配列を返します。

例

この例では、Cookie が設定されると、イベントリスナーがイベントをコンソールに記録します。これは今設定されたばかりの Cookie を表すオブジェクトが格納された changed プロパティを持つ CookieChangeEvent オブジェクトです。

js
cookieStore.addEventListener("change", (event) => {
  console.log(event);
});

const one_day = 24 * 60 * 60 * 1000;
cookieStore.set({
  name: "cookie1",
  value: "cookie1-value",
  expires: Date.now() + one_day,
  domain: "example.com",
});

仕様書

Specification
Cookie Store API
# CookieChangeEvent

ブラウザーの互換性

BCD tables only load in the browser