puppeteer/docs/api/puppeteer.page.waitforresponse.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer ()
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.8 KiB

sidebar_label
Page.waitForResponse

Page.waitForResponse() method

Signature:

class Page {
  waitForResponse(
    urlOrPredicate:
      | string
      | ((res: HTTPResponse) => boolean | Promise<boolean>),
    options?: {
      timeout?: number;
    }
  ): Promise<HTTPResponse>;
}

Parameters

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

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.

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