CookieChangeEvent: changed property

{{securecontext_header}}{{APIRef("Cookie Store API")}}

The changed read-only property of the {{domxref("CookieChangeEvent")}} interface returns an array of the cookies that have been changed.

Note that this will exclude cookies which were created with an expiry date in the past, as these cookies are immediately deleted.

Value

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

• name

  • : A string containing the name of the cookie.

• value

  • : A string containing the value of the cookie.

• domain

  • : A string containing the domain of the cookie.

• path

  • : A string containing the path of the cookie.

• expires

  • : A timestamp, given as {{glossary("Unix time")}} in milliseconds, containing the expiration date of the cookie.

• secure

  • : A {{jsxref("boolean")}} indicating whether the cookie is used only in 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.

• partitioned

  • : A boolean indicating whether the cookie is a partitioned cookie (true) or not (false). See Cookies Having Independent Partitioned State (CHIPS) for more information.

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 oneDay = 24 * 60 * 60 * 1000;
cookieStore.set({
  name: "cookie1",
  value: "cookie1-value",
  expires: Date.now() + oneDay,
  domain: "example.com",
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}