Перейти к основному содержимому

APIResponse

Класс APIResponse представляет собой ответы, возвращаемые методом apiRequestContext.get() и аналогичными методами.


Методы​

body​

Добавлено в: v1.16 apiResponse.body

Возвращает буфер с телом ответа.

Использование

await apiResponse.body();

Возвращает


dispose​

Добавлено в: v1.16 apiResponse.dispose

Освобождает тело этого ответа. Если не вызвать, то тело останется в памяти до закрытия контекста.

Использование

await apiResponse.dispose();

Возвращает


headers​

Добавлено в: v1.16 apiResponse.headers

Объект со всеми HTTP заголовками ответа, связанными с этим ответом.

Использование

apiResponse.headers();

Возвращает


headersArray​

Добавлено в: v1.16 apiResponse.headersArray

Массив со всеми HTTP заголовками ответа, связанными с этим ответом. Имена заголовков не преобразуются в нижний регистр. Заголовки с несколькими записями, такие как Set-Cookie, появляются в массиве несколько раз.

Использование

apiResponse.headersArray();

Возвращает


json​

Добавлено в: v1.16 apiResponse.json

Возвращает JSON представление тела ответа.

Этот метод вызовет ошибку, если тело ответа не может быть разобрано с помощью JSON.parse.

Использование

await apiResponse.json();

Возвращает


ok​

Добавлено в: v1.16 apiResponse.ok

Содержит булевое значение, указывающее, был ли ответ успешным (статус в диапазоне 200-299) или нет.

Использование

apiResponse.ok();

Возвращает


securityDetails​

Добавлено в: v1.61 apiResponse.securityDetails

Возвращает информацию об SSL и другие сведения о безопасности. Возвращает null для ответов не по HTTPS. Для запросов с перенаправлениями возвращает информацию о последнем запросе в цепочке перенаправлений.

Использование

await apiResponse.securityDetails();

Возвращает

  • Promise<null | Object>#
    • issuer string (optional)

      Компонент Common Name поля Issuer сертификата. Следует использовать только в информационных целях. Необязательно.

    • protocol string (optional)

      Используемый протокол TLS (например, TLS 1.3). Необязательно.

    • subjectName string (optional)

      Компонент Common Name поля Subject из сертификата. Следует использовать только в информационных целях. Необязательно.

    • validFrom number (optional)

      Временная метка Unix (в секундах), указывающая, когда этот сертификат становится действительным. Необязательно.

    • validTo number (optional)

      Временная метка Unix (в секундах), указывающая, когда этот сертификат становится недействительным. Необязательно.


serverAddr​

Добавлено в: v1.61 apiResponse.serverAddr

Возвращает IP-адрес и порт сервера. Возвращает null, если адрес сервера недоступен. Для запросов с перенаправлениями возвращает информацию о последнем запросе в цепочке перенаправлений.

Использование

await apiResponse.serverAddr();

Возвращает


status​

Добавлено в: v1.16 apiResponse.status

Содержит код состояния ответа (например, 200 для успешного ответа).

Использование

apiResponse.status();

Возвращает


statusText​

Добавлено в: v1.16 apiResponse.statusText

Содержит текст состояния ответа (например, обычно "OK" для успешного ответа).

Использование

apiResponse.statusText();

Возвращает


text​

Добавлено в: v1.16 apiResponse.text

Возвращает текстовое представление тела ответа.

Использование

await apiResponse.text();

Возвращает


timing​

Добавлено в: v1.62 apiResponse.timing

Возвращает временные характеристики загрузки ресурса для данного ответа. Для запросов с перенаправлениями возвращает информацию о последнем запросе в цепочке перенаправлений. Когда ответ предоставляется из HAR-файла, временные характеристики недоступны и все значения равны -1. Дополнительную информацию см. в Resource Timing API.

Использование

apiResponse.timing();

Возвращает

  • Object#
    • startTime number

      Время начала запроса в миллисекундах, прошедших с 1 января 1970 года 00:00:00 UTC.

    • domainLookupStart number

      Момент непосредственно перед началом поиска доменного имени ресурса клиентом. Значение указано в миллисекундах относительно startTime, -1, если недоступно.

    • domainLookupEnd number

      Момент непосредственно после завершения поиска доменного имени ресурса клиентом. Значение указано в миллисекундах относительно startTime, -1, если недоступно.

    • connectStart number

      Момент непосредственно перед началом установления клиентом соединения с сервером для получения ресурса. Значение указано в миллисекундах относительно startTime, -1, если недоступно.

    • secureConnectionStart number

      Момент непосредственно перед началом клиентом процесса рукопожатия для защиты текущего соединения. Значение указано в миллисекундах относительно startTime, -1, если недоступно.

    • connectEnd number

      Момент непосредственно после установления клиентом соединения с сервером для получения ресурса. Значение указано в миллисекундах относительно startTime, -1, если недоступно.

    • requestStart number

      Момент непосредственно перед началом запроса ресурса клиентом с сервера, из кеша или локального ресурса. Значение указано в миллисекундах относительно startTime, -1, если недоступно.

    • responseStart number

      Момент непосредственно после получения клиентом первого байта ответа от сервера, из кеша или локального ресурса. Значение указано в миллисекундах относительно startTime, -1, если недоступно.

    • responseEnd number

      Момент непосредственно после получения клиентом последнего байта ресурса или непосредственно перед закрытием транспортного соединения, в зависимости от того, что произойдёт раньше. Значение указано в миллисекундах относительно startTime, -1, если недоступно.


url​

Добавлено в: v1.16 apiResponse.url

Содержит URL ответа.

Использование

apiResponse.url();

Возвращает