cookies.Cookie
The Cookie
type of the cookies
API represents information about an HTTP cookie.
Type
Values of this type are objects, which can contain the following properties:
domain
- A
string
representing the domain the cookie belongs to (e.g. "www.google.com", "example.com"). expirationDate
Optional- 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
- A
string
representing the value of the cookie.
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
Cookie | ChromeFull supportYes | EdgeFull support14 | FirefoxFull support45 | OperaFull supportYes | SafariFull support14 | Firefox for AndroidFull support48 |
firstPartyDomain | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support59 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support59 |
sameSite | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support63 | OperaNo supportNo | SafariFull support14
| Firefox for AndroidFull support63 |
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
Examples
Most methods in the cookies API involve a Cookie
object being used either as an input parameter or as part of the return value. For example, a call to cookies.getAll()
returns an array of Cookie
objects.
In the example below we've asked for all cookies, then logged some of the values of 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}`);
}
}
var gettingAll = browser.cookies.getAll({});
gettingAll.then(logCookies);
This API is based on Chromium's chrome.cookies
API. This documentation is derived from cookies.json
in the Chromium code.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.