Interface APIResponse

APIResponse class represents responses returned by apiRequestContext.get(url[, options]) and similar methods.

Hierarchy

  • APIResponse

Methods

body dispose headers headersArray json ok status statusText text url

Methods

body

  • Returns the buffer with response body.

    Returns Promise<Buffer>

dispose

  • Disposes the body of this response. If not called then the body will stay in memory until the context closes.

    Returns Promise<void>

headers

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

    Returns {
        [key: string]: string;
    }

    • [key: string]: string

headersArray

  • An array with all the request HTTP headers associated with this response. Header names are not lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.

    Returns {
        name: string;
        value: string;
    }[]

json

  • Returns the JSON representation of response body.

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

    Returns Promise<any>

ok

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

    Returns boolean

status

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

    Returns number

statusText

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

    Returns string

text

  • Returns the text representation of response body.

    Returns Promise<string>

url

  • Contains the URL of the response.

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc