CookieChangeEvent.changed

Secure context

This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The changed read-only property of the CookieChangeEvent interface returns an array of the cookies that have been changed.

Syntax

var array = CookieChangeEvent.changed;

Value

An array of objects containing the changed cookie(s). Each object contains the following properties:

name
A USVString containing the name of the cookie.
value
A USVString containing the value of the cookie.
domain
A USVString containing the domain of the cookie.
path
A USVString containing the path of the cookie.
expires
A DOMTimeStamp containing the expiration date of the cookie.
secure
A boolean indicating whether the cookie is from a site with a secure context (HTTPS rather than HTTP).
sameSite
One of the following SameSite values:
"strict"
Cookies will only be sent in a first-party context and not be sent with requests initiated by third party websites.
"lax"
Cookies are not sent on normal cross-site subrequests (for example to load images or frames into a third party site), but are sent when a user is navigating within the origin site (i.e. when following a link).
"none"
Cookies will be sent in all contexts.

Note

For more information on SameSite cookies see SameSite cookies explained.

Examples

In this example when the cookie is set, the event listener logs the changed property to the console. The first item in that array contains an object representing the cookie that has just been set.

cookieStore.addEventListener('change', (event) => {
  console.log(event.changed[0]);
});

const one_day = 24 * 60 * 60 * 1000;
cookieStore.set({
  name: "cookie1",
  value: "cookie1-value",
  expires: Date.now() + one_day,
  domain: "example.com"
});

Specifications

Specification
Cookie Store API
# dom-cookiechangeevent-changed

Browser compatibility

BCD tables only load in the browser