CookieChangeEvent.deleted

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 deleted read-only property of the CookieChangeEvent interface returns an array of the cookies that have been deleted by the given CookieChangeEvent instance.

Value

An array of objects containing the deleted 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 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 deleted the event listener logs the first item in the CookieChangeEvent.deleted property to the console. It contains an object representing the cookie that has just been deleted.

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

Specifications

Specification
Cookie Store API
# dom-cookiechangeevent-deleted

Browser compatibility

BCD tables only load in the browser