Response

Response class represents responses which are received by page.

Methods​

allHeaders​

An object with all the response HTTP headers associated with this response.

Usage

await response.allHeaders();

Returns

• Promise<Object<string, string>>

body​

Returns the buffer with response body.

Usage

await response.body();

Returns

• Promise<Buffer>

finished​

Waits for this response to finish, returns always null.

Usage

await response.finished();

Returns

• Promise<null | Error>

frame​

Returns the Frame that initiated this response.

Usage

response.frame();

Returns

• Frame

fromServiceWorker​

Indicates whether this Response was fulfilled by a Service Worker's Fetch Handler (i.e. via FetchEvent.respondWith).

Usage

response.fromServiceWorker();

Returns

• boolean

headerValue​

Returns the value of the header matching the name. The name is case insensitive. If multiple headers have the same name (except set-cookie), they are returned as a list separated by , . For set-cookie, the \n separator is used. If no headers are found, null is returned.

Usage

await response.headerValue(name);

Arguments

• name string

  Name of the header.

Returns

• Promise<null | string>

headerValues​

Returns all values of the headers matching the name, for example set-cookie. The name is case insensitive.

Usage

await response.headerValues(name);

Arguments

• name string

  Name of the header.

Returns

• Promise<Array<string>>

headers​

An object with the response HTTP headers. The header names are lower-cased. Note that this method does not return security-related headers, including cookie-related ones. You can use response.allHeaders() for complete list of headers that include cookie information.

Usage

response.headers();

Returns

• Object<string, string>

headersArray​

An array with all the request HTTP headers associated with this response. Unlike response.allHeaders(), header names are NOT lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.

Usage

await response.headersArray();

Returns

• Promise<Array<Object>>

  • name string

    Name of the header.

  • value string

    Value of the header.

json​

Returns the JSON representation of response body.

This method will throw if the response body is not parsable via JSON.parse.

Usage

await response.json();

Returns

• Promise<Serializable>

ok​

Contains a boolean stating whether the response was successful (status in the range 200-299) or not.

Usage

response.ok();

Returns

• boolean

request​

Returns the matching Request object.

Usage

response.request();

Returns

• Request

securityDetails​

Returns SSL and other security information.

Usage

await response.securityDetails();

Returns

• Promise<null | Object>

  • issuer string (optional)

    Common Name component of the Issuer field. from the certificate. This should only be used for informational purposes. Optional.

  • protocol string (optional)

    The specific TLS protocol used. (e.g. TLS 1.3). Optional.

  • subjectName string (optional)

    Common Name component of the Subject field from the certificate. This should only be used for informational purposes. Optional.

  • validFrom number (optional)

    Unix timestamp (in seconds) specifying when this cert becomes valid. Optional.

  • validTo number (optional)

    Unix timestamp (in seconds) specifying when this cert becomes invalid. Optional.

serverAddr​

Returns the IP address and port of the server.

Usage

await response.serverAddr();

Returns

• Promise<null | Object>

  • ipAddress string

    IPv4 or IPV6 address of the server.

  • port number

status​

Contains the status code of the response (e.g., 200 for a success).

Usage

response.status();

Returns

• number

statusText​

Contains the status text of the response (e.g. usually an "OK" for a success).

Usage

response.statusText();

Returns

• string

text​

Returns the text representation of response body.

Usage

await response.text();

Returns

• Promise<string>

url​

Contains the URL of the response.

Usage

response.url();

Returns

• string