playwright/docs/src/api/class-response.md
Josh Soref 7abbbd0c84
docs: spelling (#31779)
Fixes misspellings identified by the [check-spelling
action](https://github.com/marketplace/actions/check-spelling).

The misspellings have been reported at
https://github.com/jsoref/playwright/actions/runs/10015023629#summary-27685777352

The action will report that the changes in this PR would make it happy:
https://github.com/jsoref/playwright/actions/runs/10015023971#summary-27685778305

---

I understand that the commit messages will need to be reworded to match
house style. For the time being, these are merely noting the changes
they contain so that when I rebase or need to drop things, I can. --
I've already rebased once as someone fixed one of the items that my
draft work was going to fix.

---

## Testing
* The tests _mostly_ passed when I managed to trigger them, but there
were a handful of things that I didn't quite understand
* There are a large number of warnings relating to a bad interaction
between any workflow that uses this local action
b535139b32/.github/actions/run-test/action.yml (L74-L80)
and the action it calls -- I've opened Azure/login#474 asking them to
refactor their action so that it doesn't cause so much noise while
running this repository's tests
* I'm vaguely curious as to why this repository has a `branch`
constraint for its `pull_request` events in its workflows -- that
constraint gave me a number of additional headaches while trying to
prepare this branch for this PR.

---------

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2024-07-22 06:45:22 -07:00

4.6 KiB

class: Response

  • since: v1.8

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

async method: Response.allHeaders

  • since: v1.15
  • returns: <[Object]<[string], [string]>>

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

async method: Response.body

  • since: v1.8
  • returns: <[Buffer]>

Returns the buffer with response body.

async method: Response.finished

  • since: v1.8
  • returns: <[null]|[string]>

Waits for this response to finish, returns always null.

async method: Response.finished

  • since: v1.8
  • langs: js
  • returns: <[null]|[Error]>

method: Response.frame

  • since: v1.8
  • returns: <[Frame]>

Returns the [Frame] that initiated this response.

method: Response.fromServiceWorker

  • since: v1.23
  • returns: <[boolean]>

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

method: Response.headers

  • since: 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 [method: Response.allHeaders] for complete list of headers that include cookie information.

async method: Response.headersArray

  • since: v1.15
  • returns: <[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 [method: Response.allHeaders], header names are NOT lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.

async method: Response.headerValue

  • since: v1.15
  • 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

  • since: v1.15
  • name <[string]>

Name of the header.

async method: Response.headerValues

  • since: v1.15
  • 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

  • since: v1.15
  • name <[string]>

Name of the header.

async method: Response.json

  • since: v1.8
  • 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

  • since: v1.8
  • langs: csharp
  • returns: <[null]|[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

  • since: v1.8
  • returns: <[boolean]>

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

method: Response.request

  • since: v1.8
  • returns: <[Request]>

Returns the matching [Request] object.

async method: Response.securityDetails

  • since: v1.13
  • 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

  • since: v1.13
  • 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

  • since: v1.8
  • returns: <[int]>

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

method: Response.statusText

  • since: v1.8
  • returns: <[string]>

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

async method: Response.text

  • since: v1.8
  • returns: <[string]>

Returns the text representation of response body.

method: Response.url

  • since: v1.8
  • returns: <[string]>

Contains the URL of the response.