puppeteer/docs/api/puppeteer.page.waitforresponse.md

sidebar_label

sidebar_label
Page.waitForResponse

Page.waitForResponse() method

Signature

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

Parameters

Parameter	Type	Description
urlOrPredicate	string | AwaitablePredicate<HTTPResponse>	A URL or predicate to wait for.
options	WaitTimeoutOptions	(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.

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

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