CookieStoreManager.unsubscribe()

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The unsubscribe() method of the CookieStoreManager interface stops the ServiceWorkerRegistration from receiving previously subscribed events.

Syntax

unsubscribe(subscriptions)

Parameters

subscriptions

An object containing:

name

A string with the name of a cookie.

url

A string with the url of the scope used to subscribe to this cookie.

Return value

A Promise that resolves with undefined when the subscription completes.

Exceptions

TypeError

Thrown if the URL passed in subscriptions does not match the service worker registration's scope.

Examples

In this example the ServiceWorkerRegistration represented by registration is unsubscribing from change events on the cookie named "cookie1" with a scope of "/path1".

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

Specifications

Specification
Cookie Store API
# dom-cookiestoremanager-unsubscribe

Browser compatibility

BCD tables only load in the browser