CookieStore:delete() 方法

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

安全上下文: 此项功能仅在一些支持的浏览器安全上下文(HTTPS)中可用。

备注: 此特性在 Web Worker 中可用。

CookieStore 接口的 delete() 方法通过 nameoptions 对象删除 cookie。delete() 方法通过将日期更改为过去的日期来使 cookie 过期。

语法

js
delete(name)
delete(options)

参数

此方法需要以下任意一个:

name 可选

记录 cookie 名称的字符串。

options 可选

一个包括以下属性的对象:

name

记录 cookie 名称的字符串。

domain 可选

记录 cookie 域名的字符串。默认为 null

path 可选

记录 cookie 路径的字符串。默认为 /

partitioned 可选

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

返回值

一个在删除完成后兑现为 undefinedPromise

异常

SecurityError DOMException

如果源无法被序列化成 URL,则抛出该异常。

TypeError

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

示例

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

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

console.log(result);

规范

Specification
Cookie Store API
# dom-cookiestore-delete

浏览器兼容性

BCD tables only load in the browser