APIResponse

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

Методы​

body​

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

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

await apiResponse.body();

Возвращает

• Promise<Buffer>

dispose​

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

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

await apiResponse.dispose();

Возвращает

• Promise<void>

headers​

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

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

apiResponse.headers();

Возвращает

• Object<string, string>

headersArray​

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

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

apiResponse.headersArray();

Возвращает

• Array<Object>

  • name string

    Имя заголовка.

  • value string

    Значение заголовка.

json​

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

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

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

await apiResponse.json();

Возвращает

• Promise<Serializable>

ok​

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

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

apiResponse.ok();

Возвращает

• boolean

securityDetails​

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

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

await apiResponse.securityDetails();

Возвращает

• Promise<null | Object>

  • issuer string (необязательно)

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

  • protocol string (необязательно)

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

  • subjectName string (необязательно)

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

  • validFrom number (необязательно)

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

  • validTo number (необязательно)

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

serverAddr​

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

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

await apiResponse.serverAddr();

Возвращает

• Promise<null | Object>

  • ipAddress string

    IPv4- или IPv6-адрес сервера.

  • port number

status​

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

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

apiResponse.status();

Возвращает

• number

statusText​

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

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

apiResponse.statusText();

Возвращает

• string

text​

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

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

await apiResponse.text();

Возвращает

• Promise<string>

timing​

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

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

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​

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

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

apiResponse.url();

Возвращает

• string