Spec-Zone.ru › Web APIs

CookieStore: метод get()

Ограниченная доступность

Эта функция не относится к Baseline, так как она не работает в некоторых из наиболее широко используемых браузеров.

  • Узнать больше
  • Полная совместимость
  • Отправить отзыв

Безопасный контекст: Эта функция доступна только в безопасных контекстах (HTTPS) в некоторых или во всех поддерживающих браузерах.

Примечание: Эта функция доступна в Service Workers.

Метод get() интерфейса CookieStore возвращает один cookie с заданным name или options объектом. Метод вернёт первый совпавший cookie для переданных параметров.

Синтаксис

get(name)
get(options)

Параметры

Этот метод требует одного из следующих:

name Необязательно

Строка с именем cookie.

Или

options Необязательно

Объект, содержащий:

name

Строка с именем cookie.

url

Строка с URL cookie.

Примечание: Параметр url позволяет изменять cookie, ограниченный определённым URL. Service worker могут получить cookies, которые отправлялись бы любому URL в их области действия. Из документа вы можете получить только cookies текущего URL, так что единственный допустимый URL в контексте документа — это URL документа.

Возвращаемое значение

Объект Promise, который разрешается объектом, представляющим первый cookie, соответствующий переданному name или options. Этот объект содержит следующие свойства:

domain

Строка, содержащая домен cookie.

expires

Маркер времени, заданный в миллисекундах времени Unix, содержащий срок действия cookie.

name

Строка, содержащая имя cookie.

partitioned

Булево значение, указывающее, является ли cookie разделенным cookie (true) или нет (false). См. Cookie с независимым разделенным состоянием (CHIPS) для получения дополнительной информации.

path

Строка, содержащая путь cookie.

sameSite

Одно из следующих значений SameSite:

"strict"

Cookies будут отправляться только в контексте первого уровня и не будут отправляться с запросами, инициированными веб-сайтами третьих сторон.

"lax"

Cookies не отправляются при обычных межсайтовых подзапросах (например, для загрузки изображений или фреймов на сайт третьих сторон), но отправляются, когда пользователь переходит по ссылке на сайте источника.

"none"

Cookies будут отправляться во всех контекстах.

secure

Булево значение, указывающее, используется ли cookie только в безопасных контекстах (true) или нет (false).

value

Строка, содержащая значение cookie.

Исключения

SecurityError DOMException

Выбрасывается, если источник не может сериализоваться в URL.

TypeError

Выбрасывается, если:

  • Параметр options является пустым объектом.
  • Параметр url присутствует и не равен URL создания, если в основном потоке.
  • Параметр url присутствует и его источник не совпадает с источником URL создания.
  • Получение cookies, представленных данным name или options, не выполняется.

Примеры

В этом примере мы возвращаем cookie с именем "cookie1". Если cookie найден, результатом Promise является объект, содержащий детали одного cookie.

const cookie = await cookieStore.get("cookie1");

if (cookie) {
  console.log(cookie);
} else {
  console.log("Cookie not found");
}

Спецификации

Спецификация
API cookie-хранилища
# dom-cookiestore-get

Совместимость браузеров

Рабочие столы Мобильные
Chrome Edge Firefox Opera Safari Chrome Android Firefox for Android Opera Android Safari на iOS Samsung Internet WebView Android
get 87 87 предварительный просмотр 73 Нет 87 Нет 62 Нет 14.0 87
partitioned_return_property 114 114 Нет 100 Нет 114 Нет 76 Нет 23.0 114

© 2005–2024 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/CookieStore/get

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API