Back to Puppeteer

Page.waitForResponse() method

website/versioned_docs/version-24.40.0/api/puppeteer.page.waitforresponse.md

19.2.21.6 KB
Original Source

Page.waitForResponse() method

Signature

typescript
class Page {
  waitForResponse(
    urlOrPredicate: string | AwaitablePredicate<HTTPResponse>,
    options?: WaitTimeoutOptions,
  ): Promise<HTTPResponse>;
}

Parameters

<table><thead><tr><th>

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

urlOrPredicate

</td><td>

string | AwaitablePredicate<HTTPResponse>

</td><td>

A URL or predicate to wait for.

</td></tr> <tr><td>

options

</td><td>

WaitTimeoutOptions

</td><td>

(Optional) Optional waiting parameters

</td></tr> </tbody></table>

Returns:

Promise<HTTPResponse>

Promise which resolves to the matched response.

Remarks

Optional Parameter have:

  • timeout: Maximum wait time in milliseconds, defaults to 30 seconds, pass 0 to disable the timeout. The default value can be changed by using the Page.setDefaultTimeout() method.

  • signal: A signal object that allows you to cancel a waitForResponse call.

Example

ts
const firstResponse = await page.waitForResponse(
  'https://example.com/resource',
);
const finalResponse = await page.waitForResponse(
  response =>
    response.url() === 'https://example.com' && response.status() === 200,
);
const finalResponse = await page.waitForResponse(async response => {
  return (await response.text()).includes('<html>');
});
return finalResponse.ok();