puppeteer/website/versioned_docs/version-16.1.0/api/puppeteer.page.waitforrequest.md
release-please[bot] 2d5f216621
chore(main): release 16.1.0 (#8743)
* chore(main): release 16.1.0

* chore: generate versioned docs

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2022-08-06 16:49:20 +02:00

1.7 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 response

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 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();