puppeteer/docs/api/puppeteer.page.waitforrequest.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer (#9150)
This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 09:07:05 +02:00

1.6 KiB

sidebar_label
Page.waitForRequest

Page.waitForRequest() method

Signature:

class Page {
  waitForRequest(
    urlOrPredicate: string | ((req: HTTPRequest) => boolean | Promise<boolean>),
    options?: {
      timeout?: number;
    }
  ): Promise<HTTPRequest>;
}

Parameters

Parameter Type Description
urlOrPredicate string | ((req: HTTPRequest) => boolean | Promise<boolean>) A URL or predicate to wait for
options { timeout?: number; } (Optional) Optional waiting parameters

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.

Example

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