cookies.Cookie
The Cookie type of the cookies API represents information about an HTTP cookie.
The Cookie type of the cookies API represents information about an HTTP cookie.
Type
Values of this type are objects that can contain these properties:
domain- : A
stringrepresenting the domain the cookie belongs to (e.g., "www.google.com" or "example.com"). expirationDate- : A
numberrepresenting the expiration date of the cookie as the seconds after the UNIX epoch. Includes milliseconds in the fractional part. Not provided for session cookies. firstPartyDomain- : A
stringrepresenting the first-party domain associated with the cookie. This is an empty string if the cookie was set while first-party isolation was off. See First-party isolation. hostOnly- : A
boolean,trueif the cookie is a host-only cookie (i.e., the request's host must exactly match the domain of the cookie), orfalseotherwise. httpOnly- : A
boolean,trueif the cookie is marked as HttpOnly (i.e., the cookie is inaccessible to client-side scripts), orfalseotherwise. name- : A
stringrepresenting the name of the cookie. partitionKey-
: An
objectrepresenting the description of the storage partition containing the cookie. This object is omitted (null) if the cookie is not in partitioned storage. This object contains the following properties:topLevelSite- : A
stringrepresenting the first-party URL of the cookie's storage partition, if the cookie is in storage that is partitioned by top-level site.
-
path - : A
stringrepresenting the path of the cookie. secure- : A
boolean,trueif the cookie is marked as secure (i.e., its scope is limited to secure channels, typically HTTPS), orfalseotherwise. session- : A
boolean,trueif the cookie is a session cookie, orfalseif it is a persistent cookie with an expiration date. sameSite- : A cookies.SameSiteStatus value that indicates the SameSite state of the cookie.
storeId- : A
stringrepresenting the ID of the cookie store containing this cookie, as provided by cookies.getAllCookieStores(). value- : A
stringrepresenting the value of the cookie.
Examples
Most methods in the cookies API involve a Cookie object as an input parameter or as part of the return value. For example, a call to cookies.getAll() returns an array of Cookie objects.
This example asks for all cookies, then logs some of the values from each of the resulting Cookie objects:
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}`);
}
}
let gettingAll = browser.cookies.getAll({});
gettingAll.then(logCookies);
Browser compatibility
[!NOTE] This API is based on Chromium's
chrome.cookiesAPI. This documentation is derived fromcookies.jsonin the Chromium code.