CookieStoreManager: unsubscribe() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{securecontext_header}}{{APIRef("Cookie Store API")}}{{AvailableInWorkers("window_and_service")}}
The **unsubscribe()** method of the {{domxref("CookieStoreManager")}} interface stops the {{domxref("ServiceWorkerRegistration")}} from receiving previously subscribed events.
Syntax
js-nolint
unsubscribe(subscriptions)Parameters
subscriptions- : An object list, each 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 {{jsxref("Promise")}} that resolves with {{jsxref("undefined")}} when the service worker has been unsubscribed.
Exceptions
- {{jsxref("TypeError")}}
- : Thrown if the URL passed in
subscriptionsdoes not match the service worker registration's {{domxref("ServiceWorkerRegistration.scope","scope")}}.
Examples
In this example, the {{domxref("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
{{Specifications}}
Browser compatibility
{{Compat}}