cookies.Cookie
Тип Cookie
из cookies
API представляет собой информацию о HTTP cookie.
Тип
Значения этого типа - объекты, которые могут содержать следующие свойства:
name
-
string
- содержит имя cookie. value
-
string
- содержит значение cookie. domain
-
string
- содержит домен, которому принадлежит cookie (например, "www.google.com", "example.com"). hostOnly
-
boolean
-true
если cookie является host-only (то есть запрашивающий хост должен в точности совпадать с доменом cookie), в ином случаеfalse
. path
-
string
- содержит path cookie. secure
-
boolean
-true
, если cookie помечен как secure (то есть его область действия ограничена безопасными каналами, обычно HTTPS), в ином случаеfalse
. httpOnly
-
boolean
-true
если cookie помечен как HttpOnly (то есть он недоступен для клиентских скриптов), иначеfalse
. session
-
boolean
-true
если cookie является сессионным,false
если cookie является постоянным с указанным временем жизни. expirationDate
Необязательный-
number
- содержит срок годности cookie, который представляется количеством секунд с начала UNIX-эры. Отсутствует для сессионных cookie. storeId
-
string
- представляет собой ID хранилища, в котором хранится данный cookie, как указано в соответствии сcookies.getAllCookieStores()
.
Совместимость с браузерами
BCD tables only load in the browser
Примеры
В большинстве методов из cookies API объекты типа Cookie
используются как входные параметры методов, либо же как возвращаемые значения. К примеру, вызов cookies.getAll()
возвращает массив объектов типа Cookie
.
В примере ниже мы запрашиваем все cookie, а затем выводим в лог некоторые из полей полученных 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 API chrome.cookies
. Эта документация основана на cookies.json
из кода Chromium.