playwright/docs/src/api/class-response.md
2021-07-12 09:35:37 -07:00

2.6 KiB

class: Response

[Response] class represents responses which are received by page.

async method: Response.body

  • returns: <[Buffer]>

Returns the buffer with response body.

async method: Response.finished

  • returns: <[null]|[string]>

Waits for this response to finish, returns failure error if request failed.

method: Response.frame

  • returns: <[Frame]>

Returns the [Frame] that initiated this response.

method: Response.headers

  • returns: <[Object]<[string], [string]>>

Returns the object with HTTP headers associated with the response. All header names are lower-case.

async method: Response.json

  • langs: js, python
  • returns: <[Serializable]>

Returns the JSON representation of response body.

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

async method: Response.json

  • langs: csharp
  • returns: <[JsonElement?]>

Returns the JSON representation of response body.

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

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.

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.
    • validFrom <[float]> Unix timestamp (in seconds) specifying when this cert becomes valid. Optional.
    • validTo <[float]> Unix timestamp (in seconds) specifying 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.

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.