HTTPResponse class

The HTTPResponse class represents responses which are received by the Page class.

Signature

export declare abstract class HTTPResponse

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the HTTPResponse class.

Methods

Method

Modifiers

Description

<span id="buffer">buffer()</span>

Promise which resolves to a buffer with response body.

Remarks:

The buffer might be re-encoded by the browser based on HTTP-headers or other heuristics. If the browser failed to detect the correct encoding, the buffer might be encoded incorrectly. See https://github.com/puppeteer/puppeteer/issues/6478.

<span id="content">content()</span>

Promise which resolves to a buffer with response body.

Remarks:

The buffer might be re-encoded by the browser based on HTTP-headers or other heuristics. If the browser failed to detect the correct encoding, the buffer might be encoded incorrectly. See https://github.com/puppeteer/puppeteer/issues/6478.

<span id="frame">frame()</span>

A Frame that initiated this response, or null if navigating to error pages.

<span id="fromcache">fromCache()</span>

True if the response was served from either the browser's disk cache or memory cache.

<span id="fromserviceworker">fromServiceWorker()</span>

True if the response was served by a service worker.

<span id="headers">headers()</span>

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

<span id="json">json()</span>

Promise which resolves to a JSON representation of response body.

Remarks:

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

<span id="ok">ok()</span>

True if the response was successful (status in the range 200-299).

<span id="remoteaddress">remoteAddress()</span>

The IP address and port number used to connect to the remote server.

<span id="request">request()</span>

A matching HTTPRequest object.

<span id="securitydetails">securityDetails()</span>

SecurityDetails if the response was received over the secure connection, or null otherwise.

<span id="status">status()</span>

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

<span id="statustext">statusText()</span>

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

<span id="text">text()</span>

Promise which resolves to a text (utf8) representation of response body.

Remarks:

This method will throw if the content is not utf-8 string

<span id="timing">timing()</span>

Timing information related to the response.

<span id="url">url()</span>

The URL of the response.