CookieStoreManager: unsubscribe() 方法

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

注意:此功能在服务工作者中可用。

CookieStoreManager 接口的 unsubscribe() 方法会阻止 ServiceWorkerRegistration 接收之前订阅的事件。

语法

js
unsubscribe(subscriptions)

参数

subscriptions

一个对象列表,每个对象包含

name

包含 Cookie 名称的字符串。

url

包含用于订阅此 Cookie 的作用域的 URL 的字符串。

返回值

一个Promise,在服务工作者取消订阅后,该 Promise 会解析为undefined

异常

TypeError

如果 subscriptions 中传递的 URL 与服务工作者注册的scope不匹配,则抛出该异常。

示例

在此示例中,由 registration 表示的 ServiceWorkerRegistration 正从作用域为 "/path1" 的名为 "cookie1" 的 Cookie 的更改事件中取消订阅。

js
const subscriptions = [{ name: "cookie1", url: `/path1` }];
await registration.cookies.unsubscribe(subscriptions);

规范

规范
Cookie Store API
# dom-cookiestoremanager-unsubscribe

浏览器兼容性

BCD 表仅在浏览器中加载