web api overview
Cookie Store API
Secure contextAvailable in workers
The Cookie Store API is an asynchronous API for managing cookies, available in windows and also service workers.
Concepts and Usage
The original method of getting and setting cookies involves working with cookie to get and set cookie information as a string of key/value pairs.
In addition to this being cumbersome and error prone, it also has a host of issues in the context of modern web development.
The document.cookie interface is synchronous, single-threaded, and blocking. When writing a cookie you must wait for the browser to update the string of all cookies. In addition, the reliance on document means that cookies cannot be accessed by service workers, as they cannot access the document object.
The Cookie Store API provides an updated method of managing cookies. It is asynchronous and promise-based, therefore does not block the event loop. It does not rely on Document and so is available to service workers. The methods for getting and setting cookies also provide more feedback by way of error messages. This means that web developers do not have to set then immediately read back a cookie to check that setting was successful.
Interfaces
CookieStoreExperimental- : The
CookieStoreinterface enables getting and setting cookies.
- : The
CookieStoreManagerExperimental- : The
CookieStoreManagerinterface provides a service worker registration to enable service workers to subscribe to cookie change events.
- : The
CookieChangeEventExperimental- : A
CookieChangeEventnamedchangeis dispatched againstCookieStoreobjects inWindowcontexts when any script-visible cookies changes occur.
- : A
ExtendableCookieChangeEvent- : An
ExtendableCookieChangeEventnamedcookiechangeis dispatched inServiceWorkerGlobalScopecontexts when any script-visible cookie changes occur that match the service worker’s cookie change subscription list.
- : An
Extensions to other interfaces
cookieStoreRead only Experimental- : Returns a reference to the
CookieStoreobject associated with the service worker.
- : Returns a reference to the
cookiesRead only Experimental- : Returns a reference to the
CookieStoreManagerinterface, which enables a web app to subscribe to and unsubscribe from cookie change events.
- : Returns a reference to the
cookieStoreRead only Experimental- : Returns a reference to the
CookieStoreobject for the current document context.
- : Returns a reference to the
cookiechangeevent Experimental- : Fired when any cookie changes have occurred which match the service worker’s cookie change subscription list.