CookieStore:getAll() 方法
备注: 此特性在 Web Worker 中可用。
CookieStore
接口的 getAll()
方法返回与传递给它的 name
或 options
匹配的所有 cookie 列表。
语法
js
getAll(name)
getAll(options)
参数
返回值
一个兑现为与指定的 name
或 options
对象匹配的 cookie 信息对象的 Promise
。
每一个对象包含以下属性:
domain
-
记录 cookie 域名的字符串。
expires
-
Unix 时间戳(以毫秒为单位表示),记录 cookie 的到期日期。
name
-
记录 cookie 名称的字符串。
partitioned
-
一个布尔值,表示 cookie 是否是分区 cookie(
true
)或(false
)。更多信息请参阅 具有独立分区状态的 Cookie(CHIPS)。 path
-
记录 cookie 路径的字符串。
sameSite
-
以下
SameSite
的值之一: secure
-
一个布尔值,表示 cookie 是否仅在安全上下文中使用(
true
)或(false
)。 value
-
记录 cookie 的值的字符串。
异常
SecurityError
DOMException
-
如果源无法被序列化成 URL,则抛出该异常。
TypeError
-
以下情况抛出该异常:
- 在主线程中使用时,指定的
url
选项与创建的 URL 不一致。 - 指定的
url
选项的源与创建的 URL 的源不一致。 - 通过
name
或options
查询 Cookie 失败。
- 在主线程中使用时,指定的
示例
在此示例中,我们不传递任何参数使用 getAll()
。以对象数组的形式返回包含此上下文中所有 Cookie。
js
const cookies = await cookieStore.getAll();
if (cookies.length > 0) {
console.log(cookies);
} else {
console.log("Cookie 未找到");
}
规范
Specification |
---|
Cookie Store API # dom-cookiestore-getall |
浏览器兼容性
BCD tables only load in the browser