Cookie Store API
{{securecontext_header}} {{DefaultAPISidebar("Cookie Store API")}} {{AvailableInWorkers("window_and_service")}}
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 {{domxref("document.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 {{Glossary("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 {{domxref("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 {{Glossary("asynchronous")}} and promise-based, therefore does not block the event loop. It does not rely on {{domxref("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
{{domxref("CookieStore")}}{{Experimental_Inline}}- : The
CookieStoreinterface enables getting and setting cookies.
- : The
{{domxref("CookieStoreManager")}}{{Experimental_Inline}}- : The
CookieStoreManagerinterface provides a service worker registration to enable service workers to subscribe to cookie change events.
- : The
{{domxref("CookieChangeEvent")}}{{Experimental_Inline}}- : A
CookieChangeEventnamedchangeis dispatched againstCookieStoreobjects in{{domxref("Window")}}contexts when any script-visible cookies changes occur.
- : A
{{domxref("ExtendableCookieChangeEvent")}}- : An
ExtendableCookieChangeEventnamedcookiechangeis dispatched in{{domxref("ServiceWorkerGlobalScope")}}contexts when any script-visible cookie changes occur that match the service worker’s cookie change subscription list.
- : An
Extensions to other interfaces
{{domxref("ServiceWorkerGlobalScope.cookieStore")}}{{ReadOnlyInline}}{{Experimental_Inline}}- : Returns a reference to the
{{domxref("CookieStore")}}object associated with the service worker.
- : Returns a reference to the
{{domxref("ServiceWorkerRegistration.cookies")}}{{ReadOnlyInline}}{{Experimental_Inline}}- : Returns a reference to the
{{domxref("CookieStoreManager")}}interface, which enables a web app to subscribe to and unsubscribe from cookie change events.
- : Returns a reference to the
{{domxref("Window.cookieStore")}}{{ReadOnlyInline}}{{Experimental_Inline}}- : Returns a reference to the
{{domxref("CookieStore")}}object for the current document context.
- : Returns a reference to the
{{domxref("ServiceWorkerGlobalScope/cookiechange_event", "cookiechange")}}event{{Experimental_Inline}}- : Fired when any cookie changes have occurred which match the service worker’s cookie change subscription list.
Specifications
{{Specifications}}
Browser compatibility
{{Compat}}