CookieStore.delete()

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

var promise = cookieStore.delete(name);
var promise = cookieStore.delete(options);

Parameters

This method requires one of the following:

name

A USVString with the name of a cookie.

options

An object containing:

name

A USVString with the name of a cookie.

urlOptional

A USVString with the url of a cookie.

pathOptional

A USVString containing a path.

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

Browser compatibility