W3cubDocs

/Web APIs

CookieStoreManager: unsubscribe() method

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

js

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 service worker has been unsubscribed.

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".

js

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

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
unsubscribe 87 87 No No 73 No 87 87 No 62 No 14.0

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/CookieStoreManager/unsubscribe