Cookie Store API
Baseline
2025
*
Newly available
Since June 2025, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
* Some parts of this feature may have varying levels of support.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Service 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 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 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
-
The
CookieStoreinterface enables getting and setting cookies. -
The
CookieStoreManagerinterface provides a service worker registration to enable service workers to subscribe to cookie change events. -
A
CookieChangeEventnamedchangeis dispatched againstCookieStoreobjects inWindowcontexts when any script-visible cookies changes occur. -
An
ExtendableCookieChangeEventnamedcookiechangeis dispatched inServiceWorkerGlobalScopecontexts when any script-visible cookie changes occur that match the service worker's cookie change subscription list.
Extensions to other interfaces
-
Returns a reference to the
CookieStoreobject associated with the service worker. -
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
CookieStoreobject for the current document context. -
Fired when any cookie changes have occurred which match the service worker's cookie change subscription list.
Specifications
| Specification |
|---|
| Cookie Store API |
Browser compatibility
api.CookieStore
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
CookieStore
|
|
|
|
|
|
|
|
|
|
|
|
|
change event
|
|
|
|
|
|
|
|
|
|
|
|
|
delete
|
|
|
|
|
|
|
|
|
|
|
|
|
partitioned option
|
|
|
|
|
|
|
|
|
|
|
|
|
get
|
|
|
|
|
|
|
|
|
|
|
|
|
domain in return value
|
|
|
|
|
|
|
|
|
|
|
|
|
expires in return value
|
|
|
|
|
|
|
|
|
|
|
|
|
name in return value
|
|
|
|
|
|
|
|
|
|
|
|
|
partitioned in return value
|
|
|
|
|
|
|
|
|
|
|
|
|
path in return value
|
|
|
|
|
|
|
|
|
|
|
|
|
sameSite in return value
|
|
|
|
|
|
|
|
|
|
|
|
|
secure in return value
|
|
|
|
|
|
|
|
|
|
|
|
|
value in return value
|
|
|
|
|
|
|
|
|
|
|
|
|
getAll
|
|
|
|
|
|
|
|
|
|
|
|
|
set
|
|
|
|
|
|
|
|
|
|
|
|
|
maxAge option
|
|
|
|
|
|
|
|
|
|
|
|
|
partitioned option
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Non-standard. Check cross-browser support before using.
- See implementation notes.
api.CookieStoreManager
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
CookieStoreManager
|
|
|
|
|
|
|
|
|
|
|
|
|
getSubscriptions
|
|
|
|
|
|
|
|
|
|
|
|
|
subscribe
|
|
|
|
|
|
|
|
|
|
|
|
|
unsubscribe
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support