Cookie Store API
CookieStore 接口的 set() 方法通过给定的 name 和 value 或 options 对象设置 cookie。
语法
set(name, value)
set(options)
参数
此方法需要以下任意一个:
name- : 记录 cookie 名称的字符串。
value- : 表示 cookie 值的字符串。
或
options- : 一个包括以下属性的对象:
-
domain- : 记录 cookie 域名的字符串。默认为
null。
- : 记录 cookie 域名的字符串。默认为
-
expires- : Unix time(以毫秒为单位表示),记录 cookie 的到期日期。默认为
null。
- : Unix time(以毫秒为单位表示),记录 cookie 的到期日期。默认为
-
name- : 记录 cookie 名称的字符串。
-
partitioned- : 一个布尔值,表示 cookie 是否是分区 cookie(
true)或(false)。更多信息请参阅具有独立分区状态的 Cookie(CHIPS)。
- : 一个布尔值,表示 cookie 是否是分区 cookie(
-
path- : 记录 cookie 路径的字符串。默认为
/。
- : 记录 cookie 路径的字符串。默认为
-
sameSite- : 以下
SameSite的值之一:"strict"- : Cookie 只会在第一方上下文中发送,不会与第三方网站发起的请求一起发送。
"lax"- : Cookie 不会在正常的跨站点子请求(例如将图像或框架加载到第三方站点)中发送,而是在用户在原始站点内导航时(即点击链接时)发送。
"none"- : Cookie 将会在所有上下文中发送。
- : 以下
-
value- : 表示 cookie 的值的字符串。
-
- : 一个包括以下属性的对象:
返回值
设置 Cookie 成功时兑现为 undefined 的 Promise。
异常
SecurityErrorDOMException- : 如果源无法被Serialization成 URL,则抛出该异常。
- TypeError
- : 如果通过给定的
name和value或options设置 cookie 失败,则抛出该异常。
- : 如果通过给定的
示例
以下示例通过传递一个带有 name, value, expires 和 domain 的对象设置 cookie。
const day = 24 * 60 * 60 * 1000;
cookieStore.set({
name: "cookie1",
value: "cookie1-value",
expires: Date.now() + day,
domain: "example.com",
});
规范
浏览器兼容性
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
