TheCookieStoreManager interface of theCookie Store API allows service workers to subscribe to cookie change events. Callsubscribe() on a particular service worker registration to receive change events.

ACookieStoreManager has an associatedServiceWorkerRegistration. Each service worker registration has a cookie change subscription list, which is a list of cookie change subscriptions each containing a name and URL. The methods in this interface allow the service worker to add and remove subscriptions from this list, and to get a list of all subscriptions.

To get aCookieStoreManager, callServiceWorkerRegistration.cookies.

Instance methods

CookieStoreManager.getSubscriptions()

Returns aPromise which resolves to a list of the cookie change subscriptions for this service worker registration.

CookieStoreManager.subscribe()

Subscribes to changes to cookies. It returns aPromise which resolves when the subscription is successful.

CookieStoreManager.unsubscribe()

Unsubscribes the registered service worker from changes to cookies. It returns aPromise which resolves when the operation is successful.

Examples

In this example, theServiceWorkerRegistration represented byregistration is subscribing to change events on the cookie named"cookie1" with a scope of"/path1".

const subscriptions = [{ name: "cookie1", url: `/path1` }];await registration.cookies.subscribe(subscriptions);

If theServiceWorkerRegistration has subscribed to any cookies, thengetSubscriptions() will return a list of cookies represented by objects in the same format as used for the original subscription.

const subscriptions = await self.registration.cookies.getSubscriptions();

Specifications

Browser compatibility