cookies.Cookie
The Cookie
type of the cookies
API represents information about an HTTP cookie.
类型
这玩意是一个 Object,可以包含以下的属性:
domain
- 储存这个 cookie 对应网站的字符串 (例如 "www.tengxun.com")。
expirationDate
可选- A
number
representing the expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies. firstPartyDomain
- A
string
representing the first-party domain associated with the cookie. This will be an empty string if the cookie was set while first-party isolation was off. See First-party isolation. hostOnly
- A
boolean
,true
if the cookie is a host-only cookie (i.e. the request's host must exactly match the domain of the cookie), orfalse
otherwise. httpOnly
- A
boolean
,true
if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts), orfalse
otherwise. name
- A
string
representing the name of the cookie. path
- A
string
representing the path of the cookie. secure
- A
boolean
,true
if the cookie is marked as secure (i.e. its scope is limited to secure channels, typically HTTPS), orfalse
otherwise. session
- A
boolean
,true
if the cookie is a session cookie, orfalse
if it is a persistent cookie with an expiration date. sameSite
- A
cookies.SameSiteStatus
value that indicates the SameSite state of the cookie. storeId
- A
string
representing the ID of the cookie store containing this cookie, as provided bycookies.getAllCookieStores()
. value
- 代表 cookie 的值的一个字符串。
Browser compatibility
BCD tables only load in the browser
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
举例
Cookies API中的大多数方法都将 Cookie
对象用作输入参数或用作返回值的一部分。例如调用 cookies.getAll()
将会返回一个 Cookie
对象的数组。
在下面的例子中我们将会获取所有的 cookie ,然后 console.log()
出这些 Cookie
对象所对应的值。
function logCookies(cookies) {
for (cookie of cookies) {
console.log(`Domain: ${cookie.domain}`);
console.log(`Name: ${cookie.name}`);
console.log(`Value: ${cookie.value}`);
console.log(`Persistent: ${!cookie.session}`);
}
}
var gettingAll = browser.cookies.getAll({});
gettingAll.then(logCookies);
声明
这 API 是基于 Chromium 的 chrome.cookies
API 的。 这个文档来自于 Chromium code 中的 cookies.json
。
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.