CookieStoreManager.subscribe()
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The subscribe()
method of the CookieStoreManager
interface subscribes a ServiceWorkerRegistration
to cookie change events.
Syntax
let promise = registration.cookies.subscribe(subscriptions);
Parameters
Return value
Exceptions
Examples
In this example the ServiceWorkerRegistration
represented by registration
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);
The url passed to the subscribe()
method, may be narrower than the service worker registration scope. In the following example the subscription is for /path/one/
, so it will receive change events for changes on the first cookie, but not the second.
registration.cookies.subscribe([{name: 'cookie1', url: '/path/one/'}]); // subscription
cookieStore.set({name: 'cookie1', value: 'cookie-value', path: '/path/one/'}); // receives a change event
cookieStore.set({name: 'cookie1', value: 'cookie-value', path: '/path/two/'}); // does not receive a change event
Specifications
Specification |
---|
Cookie Store API # dom-cookiestoremanager-subscribe |
Browser compatibility
BCD tables only load in the browser