2021-01-07 11:46:05 -08:00
# class: Response
[Response] class represents responses which are received by page.
2021-09-02 11:46:52 -07:00
## async method: Response.allHeaders
2021-09-07 13:27:53 -04:00
- returns: < [Object]< [string], [string]>>
2021-09-02 11:46:52 -07:00
An object with all the response HTTP headers associated with this response.
2021-01-07 11:46:05 -08:00
## async method: Response.body
- returns: < [Buffer]>
Returns the buffer with response body.
## async method: Response.finished
2021-02-02 12:18:05 -08:00
- returns: < [null]|[string]>
2021-01-07 11:46:05 -08:00
2021-09-10 17:02:34 +02:00
Waits for this response to finish, returns always `null` .
2021-01-07 11:46:05 -08:00
## method: Response.frame
- returns: < [Frame]>
Returns the [Frame] that initiated this response.
## method: Response.headers
- returns: < [Object]< [string], [string]>>
2021-09-02 11:46:52 -07:00
**DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [`method: Response.allHeaders` ] instead.
2021-01-07 11:46:05 -08:00
2021-09-07 13:27:53 -04:00
## async method: Response.headersArray
2021-09-09 09:00:11 -07:00
- returns: < [Array]< [Object]>>
- `name` < [string]> Name of the header.
- `value` < [string]> Value of the header.
2021-09-11 13:27:00 -07:00
An array with all the request HTTP headers associated with this response. Unlike [`method: Response.allHeaders` ], header names are NOT lower-cased.
2021-09-09 09:00:11 -07:00
Headers with multiple entries, such as `Set-Cookie` , appear in the array multiple times.
2021-09-07 13:27:53 -04:00
2021-09-11 13:27:00 -07:00
## async method: Response.headerValue
- returns: < [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.
### param: Response.headerValue.name
- `name` < [string]>
Name of the header.
## async method: Response.headerValues
- returns: < [Array]< [string]>>
Returns all values of the headers matching the name, for example `set-cookie` . The name is case insensitive.
### param: Response.headerValues.name
- `name` < [string]>
Name of the header.
2021-01-07 11:46:05 -08:00
## async method: Response.json
2021-05-24 13:40:02 -07:00
* langs: js, python
2021-01-07 11:46:05 -08:00
- returns: < [Serializable]>
Returns the JSON representation of response body.
This method will throw if the response body is not parsable via `JSON.parse` .
2021-05-24 13:40:02 -07:00
## async method: Response.json
* langs: csharp
2021-09-09 11:39:26 +02:00
- returns: < [null]|[JsonElement]>
2021-05-24 13:40:02 -07:00
Returns the JSON representation of response body.
This method will throw if the response body is not parsable via `JSON.parse` .
2021-01-07 11:46:05 -08:00
## method: Response.ok
- returns: < [boolean]>
Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
## method: Response.request
- returns: < [Request]>
Returns the matching [Request] object.
2021-06-17 13:04:55 -07:00
## async method: Response.securityDetails
- returns: < [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.
2021-07-12 09:35:37 -07:00
- `validFrom` < [float]> Unix timestamp (in seconds) specifying
2021-06-17 13:04:55 -07:00
when this cert becomes valid. Optional.
2021-07-12 09:35:37 -07:00
- `validTo` < [float]> Unix timestamp (in seconds) specifying
2021-06-17 13:04:55 -07:00
when this cert becomes invalid. Optional.
Returns SSL and other security information.
## async method: Response.serverAddr
- returns: < [null]|[Object]>
- `ipAddress` < [string]> IPv4 or IPV6 address of the server.
- `port` < [int]>
Returns the IP address and port of the server.
2021-01-07 11:46:05 -08:00
## method: Response.status
- returns: < [int]>
Contains the status code of the response (e.g., 200 for a success).
## method: Response.statusText
- returns: < [string]>
Contains the status text of the response (e.g. usually an "OK" for a success).
## async method: Response.text
- returns: < [string]>
Returns the text representation of response body.
## method: Response.url
- returns: < [string]>
Contains the URL of the response.