Skip to content

Response ​

Added in: v1.8

Response class represents responses which are received by page.

Methods ​

response.all_headers() ​

Added in: v1.15

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

Returns

  • Object<string, string>

response.body() ​

Added in: v1.8

Returns the buffer with response body.

Returns

  • Buffer

response.finished() ​

Added in: v1.8

Waits for this response to finish, returns always null.

response.frame() ​

Added in: v1.8

Returns the Frame that initiated this response.

Returns

  • Frame

response.from_service_worker() ​

Added in: v1.23

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

Returns

  • boolean

response.headers() ​

Added in: v1.8

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.all_headers() for complete list of headers that include cookie information.

Returns

  • Object<string, string>

response.headers_array() ​

Added in: v1.15

An array with all the response HTTP headers associated with this response. Unlike response.all_headers(), header names are NOT lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times. Some browser network stacks combine multiple field values before reporting them, so separate entries are not always available.

Returns

  • Array<Object>

response.header_value() ​

Added in: v1.15

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.

Arguments

  • name string

    Name of the header.

Returns

  • null | string

response.header_values() ​

Added in: v1.15

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

Arguments

  • name string

    Name of the header.

Returns

  • Array<string>

response.http_version() ​

Added in: v1.59

Returns the http version used by the response.

Returns

  • string

response.json() ​

Added in: v1.8

Returns the JSON representation of response body.

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

Returns

  • Serializable

response.ok() ​

Added in: v1.8

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

Returns

  • boolean

response.request() ​

Added in: v1.8

Returns the matching Request object.

Returns

  • Request

response.security_details() ​

Added in: v1.13

Returns SSL and other security information.

Returns

  • null | Object

response.server_addr() ​

Added in: v1.13

Returns the IP address and port of the server.

Returns

  • null | Object

response.status() ​

Added in: v1.8

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

Returns

  • int

response.status_text() ​

Added in: v1.8

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

Returns

  • string

response.text() ​

Added in: v1.8

Returns the text representation of response body.

Returns

  • string

response.url() ​

Added in: v1.8

Contains the URL of the response.

Returns

  • string

Released under the Apache 2.0 License.