puppeteer/docs/api/puppeteer.page.waitforframe.md

71 lines
924 B
Markdown
Raw Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: Page.waitForFrame
---
# Page.waitForFrame() method
Waits for a frame matching the given conditions to appear.
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class Page {
waitForFrame(
urlOrPredicate: string | ((frame: Frame) => Awaitable<boolean>),
options?: WaitTimeoutOptions
2022-07-05 13:41:43 +00:00
): Promise<Frame>;
}
```
## Parameters
<table><thead><tr><th>
2022-07-05 13:41:43 +00:00
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
urlOrPredicate
</td><td>
string \| ((frame: [Frame](./puppeteer.frame.md)) =&gt; [Awaitable](./puppeteer.awaitable.md)&lt;boolean&gt;)
</td><td>
</td></tr>
<tr><td>
options
</td><td>
[WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md)
</td><td>
_(Optional)_
</td></tr>
</tbody></table>
2022-07-05 13:41:43 +00:00
**Returns:**
Promise&lt;[Frame](./puppeteer.frame.md)&gt;
## Example
```ts
const frame = await page.waitForFrame(async frame => {
return frame.name() === 'Test';
});
```