puppeteer/website/versioned_docs/version-19.7.3/api/puppeteer.page.waitforframe.md

sidebar_label
Page.waitForFrame

Page.waitForFrame() method

Signature:

class Page {
  waitForFrame(
    urlOrPredicate: string | ((frame: Frame) => boolean | Promise<boolean>),
    options?: {
      timeout?: number;
    }
  ): Promise<Frame>;
}

Parameters

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

Returns:

Promise<Frame>

Promise which resolves to the matched frame.

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 frame = await page.waitForFrame(async frame => {
  return frame.name() === 'Test';
});