CookieStore.delete()

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 delete() method of the CookieStore interface deletes a cookie with the given name or options object. (See below.) The delete() method expires the cookie by changing the date to one in the past.

Syntax

delete(name)
delete(options)

Parameters

This method requires one of the following:

name

A string with the name of a cookie.

options

An object containing:

name

A string with the name of a cookie.

url Optional

A string with the URL of a cookie.

path Optional

A string containing a path.

Note: The url option enables the modification of a cookie scoped under a particular URL. Service workers can obtain cookies that would be sent to any URL under their scope. From a document you may only obtain the cookies at the current URL, so the only valid URL in a document context is the document's URL.

Return value

A Promise that resolves with undefined when deletion completes.

Exceptions

TypeError

Thrown if deleting the cookie represented by the given name or options fails.

Examples

In this example a cookie is deleted by passing the name to the delete() method.

let result = cookieStore.delete('cookie1');
console.log(result);

Specifications

Specification
Cookie Store API
# dom-cookiestore-delete

Browser compatibility

BCD tables only load in the browser