TheExtendableCookieChangeEvent interface of theCookie Store API is the event type passed tocookiechange event fired at theServiceWorkerGlobalScope when any cookie changes occur which match the service worker's cookie change subscription list. A cookie change event consists of a cookie and a type (either "changed" or "deleted").

Cookie changes that cause theExtendableCookieChangeEvent to be dispatched are:

• A cookie is newly created and not immediately removed, or if a cookies is replaced.In this casetype is "changed".
• A cookie is newly created and immediately removed.In this casetype is "deleted"
• A cookie is removed. In this casetype is "deleted".

Constructor

ExtendableCookieChangeEvent()

Creates a newExtendableCookieChangeEvent.

Instance properties

This interface also inherits properties fromExtendableEvent.

ExtendableCookieChangeEvent.changedRead only

Returns an array containing the changed cookies.

ExtendableCookieChangeEvent.deletedRead only

Returns an array containing the deleted cookies.

Instance methods

This interface also inherits methods fromExtendableEvent.

Examples

In the below example, we useCookieStoreManager.getSubscriptions() to get a list of existing subscriptions. (In service workers, a subscription is required in order to listen for events.) We unsubscribe from existing subscriptions usingCookieStoreManager.unsubscribe(), then subscribe to the cookie with a name of 'COOKIE_NAME' usingCookieStoreManager.subscribe(). If that cookie is changed, the event listener logs the event to the console. This will be anExtendableCookieChangeEvent object, with thechanged ordeleted property containing the modified cookie.

self.addEventListener("activate", (event) => {  event.waitUntil(async () => {    const subscriptions = await self.registration.cookies.getSubscriptions();    await self.registration.cookies.unsubscribe(subscriptions);    await self.registration.cookies.subscribe([      {        name: "COOKIE_NAME",      },    ]);  });});self.addEventListener("cookiechange", (event) => {  console.log(event);});

Specifications

Browser compatibility