CookieStore:delete() 方法

安全上下文:此功能仅在安全上下文(HTTPS)中可用,且在某些或所有支持的浏览器中可用。

注意:此功能在Service Workers中可用。

delete() 方法是 CookieStore 接口的方法,用于删除具有给定 nameoptions 对象的 cookie。delete() 方法通过将日期更改为过去的时间来使 cookie 过期。

语法

js
delete(name)
delete(options)

参数

此方法需要以下之一

name 可选

包含 cookie 名称的字符串。

options 可选

包含以下内容的对象

name

包含 cookie 名称的字符串。

domain 可选

包含 cookie 域的字符串。默认为 null

path 可选

包含路径的字符串。默认为 /

partitioned 可选

布尔值,默认为 false。将其设置为 true 表示要删除的 cookie 是分区 cookie。有关更多信息,请参阅具有独立分区状态的 Cookie (CHIPS)

返回值

一个Promise,当删除完成时,该 Promise 将解析为undefined

异常

SecurityError DOMException

如果源无法序列化为 URL,则抛出此异常。

TypeError

如果删除由给定 nameoptions 表示的 cookie 失败,则抛出此异常。

示例

在此示例中,通过将名称传递给 delete() 方法来删除 cookie。

js
const result = cookieStore.delete("cookie1");

console.log(result);

规范

规范
Cookie Store API
# dom-cookiestore-delete

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。