puppeteer/docs/api/puppeteer.frame.waitforfunction.md

110 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: Frame.waitForFunction
---
# Frame.waitForFunction() method
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class Frame {
waitForFunction<
Params extends unknown[],
Func extends EvaluateFunc<Params> = EvaluateFunc<Params>,
2022-07-05 13:41:43 +00:00
>(
pageFunction: Func | string,
options?: FrameWaitForFunctionOptions,
...args: Params
): Promise<HandleFor<Awaited<ReturnType<Func>>>>;
}
```
## 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>
pageFunction
</td><td>
Func \| string
</td><td>
the function to evaluate in the frame context.
</td></tr>
<tr><td>
options
</td><td>
[FrameWaitForFunctionOptions](./puppeteer.framewaitforfunctionoptions.md)
</td><td>
_(Optional)_ options to configure the polling method and timeout.
</td></tr>
<tr><td>
args
</td><td>
Params
</td><td>
arguments to pass to the `pageFunction`.
</td></tr>
</tbody></table>
2022-07-05 13:41:43 +00:00
**Returns:**
Promise&lt;[HandleFor](./puppeteer.handlefor.md)&lt;Awaited&lt;ReturnType&lt;Func&gt;&gt;&gt;&gt;
the promise which resolve when the `pageFunction` returns a truthy value.
## Example
The `waitForFunction` can be used to observe viewport size change:
```ts
import puppeteer from 'puppeteer';
2022-07-05 13:41:43 +00:00
(async () => {
. const browser = await puppeteer.launch();
. const page = await browser.newPage();
. const watchDog = page.mainFrame().waitForFunction('window.innerWidth < 100');
. page.setViewport({width: 50, height: 50});
. await watchDog;
. await browser.close();
})();
```
To pass arguments from Node.js to the predicate of `page.waitForFunction` function:
```ts
const selector = '.foo';
await frame.waitForFunction(
selector => !!document.querySelector(selector),
{}, // empty options object
selector
);
```