CookieStore.delete()
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
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:
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
Exceptions
TypeError
-
Thrown if deleting the cookie represented by the given
name
oroptions
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