Back to Puppeteer

Page.waitForFrame() method

docs/api/puppeteer.page.waitforframe.md

19.2.21.0 KB
Original Source

Page.waitForFrame() method

Waits for a frame matching the given conditions to appear.

Signature

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

Parameters

<table><thead><tr><th>

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

urlOrPredicate

</td><td>

string | ((frame: Frame) => Awaitable<boolean>)

</td><td> </td></tr> <tr><td>

options

</td><td>

WaitTimeoutOptions

</td><td>

(Optional)

</td></tr> </tbody></table>

Returns:

Promise<Frame>

Example

ts
const frame = await page.waitForFrame(async frame => {
  const frameElement = await frame.frameElement();
  if (!frameElement) {
    return false;
  }
  const name = await frameElement.evaluate(el => el.getAttribute('name'));
  return name === 'test';
});