CookieStore

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

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

CookieStoreCookie Store API 的接口,它提供用于从页面或服务工作者异步获取和设置 cookie 的方法。

CookieStore 通过 WindowServiceWorkerGlobalScope 上下文中的全局范围内的属性访问。因此没有构造函数。

EventTarget CookieStore

实例方法

CookieStore.delete()

delete() 方法删除具有给定 nameoptions 对象的 cookie,它返回一个 Promise,该 promise 在删除完成时解析。

CookieStore.get()

get() 方法获取具有给定 nameoptions 对象的单个 cookie,它返回一个 Promise,该 promise 解析为单个 cookie 的详细信息。

CookieStore.getAll()

getAll() 方法获取所有匹配的 cookie,它返回一个 Promise,该 promise 解析为 cookie 列表。

CookieStore.set()

set() 方法设置具有给定 namevalueoptions 对象的 cookie,它返回一个 Promise,该 promise 在 cookie 设置时解析。

事件

更改

change 事件在任何 cookie 发生更改时触发。

示例

在此示例中,我们设置一个 cookie 并将操作成功或失败的反馈写入控制台。

js
const day = 24 * 60 * 60 * 1000;

cookieStore
  .set({
    name: "cookie1",
    value: "cookie1-value",
    expires: Date.now() + day,
    domain: "example.com",
  })
  .then(
    () => {
      console.log("It worked!");
    },
    (reason) => {
      console.error("It failed: ", reason);
    },
  );

规范

规范
Cookie Store API
# CookieStore

浏览器兼容性

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