CookieStoreManager.unsubscribe()

Secure context

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

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

Syntax

let promise = registration.cookies.unsubscribe(subscriptions);

Parameters

subscriptions
An object containing:
name
A USVString with the name of a cookie.
url
A USVString 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 Status Comment
Cookie Store API
The definition of 'CookieStoreManager.unsubscribe()' in that specification.
Draft Initial definition.

Browser compatibility

BCD tables only load in the browser