Response

Response class represents responses which are received by page.

• response.allHeaders()
• response.body()
• response.finished()
• response.frame()
• response.fromServiceWorker()
• response.headers()
• response.headersArray()
• response.headerValue(name)
• response.headerValues(name)
• response.json()
• response.ok()
• response.request()
• response.securityDetails()
• response.serverAddr()
• response.status()
• response.statusText()
• response.text()
• response.url()

response.allHeaders()

Added in: v1.15

• returns: <Promise<Object<string, string>>>#

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

response.body()

Added in: v1.8

• returns: <Promise<Buffer>>#

Returns the buffer with response body.

response.finished()

Added in: v1.8

• returns: <Promise<null|Error>>#

Waits for this response to finish, returns always null.

response.frame()

Added in: v1.8

• returns: <Frame>#

Returns the Frame that initiated this response.

response.fromServiceWorker()

Added in: v1.23

• returns: <boolean>#

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

response.headerValue(name)

Added in: v1.15

• name <string> Name of the header.#
• returns: <Promise<null|string>>#

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.

response.headerValues(name)

Added in: v1.15

• name <string> Name of the header.#
• returns: <Promise<Array<string>>>#

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

response.headers()

Added in: v1.8

• returns: <Object<string, string>>#

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.

response.headersArray()

Added in: v1.15

• returns: <Promise<Array<Object>>>#
  • name <string> Name of the header.
  • value <string> Value of the header.

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.

response.json()

Added in: v1.8

• returns: <Promise<Serializable>>#

Returns the JSON representation of response body.

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

response.ok()

Added in: v1.8

• returns: <boolean>#

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

response.request()

Added in: v1.8

• returns: <Request>#

Returns the matching Request object.

response.securityDetails()

Added in: v1.13

• returns: <Promise<null|Object>>#
  • issuer? <string> Common Name component of the Issuer field. from the certificate. This should only be used for informational purposes. Optional.
  • protocol? <string> The specific TLS protocol used. (e.g. TLS 1.3). Optional.
  • subjectName? <string> Common Name component of the Subject field from the certificate. This should only be used for informational purposes. Optional.
  • validFrom? <number> Unix timestamp (in seconds) specifying when this cert becomes valid. Optional.
  • validTo? <number> Unix timestamp (in seconds) specifying when this cert becomes invalid. Optional.

Returns SSL and other security information.

response.serverAddr()

Added in: v1.13

• returns: <Promise<null|Object>>#
  • ipAddress <string> IPv4 or IPV6 address of the server.
  • port <number>

Returns the IP address and port of the server.

response.status()

Added in: v1.8

• returns: <number>#

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

response.statusText()

Added in: v1.8

• returns: <string>#

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

response.text()

Added in: v1.8

• returns: <Promise<string>>#

Returns the text representation of response body.

response.url()

Added in: v1.8

• returns: <string>#

Contains the URL of the response.