Spec-Zone.ru › Web APIs

CookieStore: метод getAll()

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

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

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

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

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

Метод getAll() интерфейса CookieStore возвращает список куки, которые соответствуют name или options, переданных в качестве аргументов. Если не передавать параметры, будут возвращены все куки для текущего контекста.

Синтаксис

getAll(name)
getAll(options)

Параметры

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

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

Или

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

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

name

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

url

Строка с URL куки.

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

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

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

Каждый объект содержит следующие свойства:

domain

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

expires

Отметка времени (в миллисекундах) в формате времени Unix, содержащая дату истечения срока действия куки.

name

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

partitioned

Булево значение, указывающее, является ли куки разделенной (true) или нет (false). Подробнее см. Cookies Having Independent Partitioned State (CHIPS).

path

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

sameSite

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

"strict"

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

"lax"

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

"none"

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

secure

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

value

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

Исключения

SecurityError DOMException

Бросается, если происхождение не может быть сериализовано в URL.

TypeError

Бросается, если:

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

Примеры

В этом примере мы используем getAll() без параметров. Это возвращает все куки для данного контекста в виде массива объектов.

const cookies = await cookieStore.getAll();

if (cookies.length > 0) {
  console.log(cookies);
} else {
  console.log("Cookie not found");
}

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

Спецификация
API Cookie Store
# dom-cookiestore-getall

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

Рабочий стол Мобильные устройства
Chrome Edge Firefox Opera Safari Chrome Android Firefox for Android Opera Android Safari на iOS Samsung Internet WebView Android
getAll 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/getAll

Spec-Zone.ru

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