Back to Puppeteer

Page.waitForRequest() method

docs/api/puppeteer.page.waitforrequest.md

19.2.21.4 KB
Original Source

Page.waitForRequest() method

Signature

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

Parameters

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

Parameter

</th><th>

Type

</th><th>

Description

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

urlOrPredicate

</td><td>

string | AwaitablePredicate<HTTPRequest>

</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<HTTPRequest>

Promise which resolves to the matched request

Remarks

Optional Waiting Parameters 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 waitForRequest call.

Example

ts
const firstRequest = await page.waitForRequest('https://example.com/resource');
const finalRequest = await page.waitForRequest(
  request => request.url() === 'https://example.com',
);
return finalRequest.response()?.ok();