Cookie Store API
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 Cookie Store API provides an asynchronous API for managing cookies, while also exposing cookies to Service Worker API,
Concepts and Usage
The existing method of getting and setting cookies involves working with document.cookie
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 which 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
-
The
CookieStore
interface enables getting and setting cookies. -
The
CookieStoreManager
interface provides a service worker registration to enable service workers to subscribe to cookie change events. -
A
CookieChangeEvent
namedchange
is dispatched againstCookieStore
objects inWindow
contexts when any script-visible cookies changes occur. -
An
ExtendableCookieChangeEvent
namedchange
is dispatched againstServiceWorkerGlobalScope
events when any script-visible cookie changes occur that match the service worker's cookie change subscription list.
Specifications
Specification |
---|
Cookie Store API # CookieStore |
Browser compatibility
BCD tables only load in the browser