puppeteer/website/versioned_docs/version-19.5.2/api/puppeteer.frame.waitforfunction.md
release-please[bot] e9df6750d2
chore: release main (#9495)
🤖 I have created a release *beep* *boop*
---


<details><summary>puppeteer: 19.5.2</summary>

##
[19.5.2](https://github.com/puppeteer/puppeteer/compare/puppeteer-v19.5.1...puppeteer-v19.5.2)
(2023-01-11)


### Miscellaneous Chores

* **puppeteer:** Synchronize puppeteer versions


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * puppeteer-core bumped from 19.5.1 to 19.5.2
</details>

<details><summary>puppeteer-core: 19.5.2</summary>

##
[19.5.2](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v19.5.1...puppeteer-core-v19.5.2)
(2023-01-11)


### Bug Fixes

* make sure browser fetcher in launchers uses configuration
([#9493](https://github.com/puppeteer/puppeteer/issues/9493))
([df55439](df554397b5)),
closes [#9470](https://github.com/puppeteer/puppeteer/issues/9470)
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2023-01-12 08:21:09 +01:00

63 lines
2.0 KiB
Markdown

---
sidebar_label: Frame.waitForFunction
---
# Frame.waitForFunction() method
#### Signature:
```typescript
class Frame {
waitForFunction<
Params extends unknown[],
Func extends EvaluateFunc<Params> = EvaluateFunc<Params>
>(
pageFunction: Func | string,
options?: FrameWaitForFunctionOptions,
...args: Params
): Promise<HandleFor<Awaited<ReturnType<Func>>>>;
}
```
## Parameters
| Parameter | Type | Description |
| ------------ | ------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| pageFunction | Func \| string | the function to evaluate in the frame context. |
| options | [FrameWaitForFunctionOptions](./puppeteer.framewaitforfunctionoptions.md) | <i>(Optional)</i> options to configure the polling method and timeout. |
| args | Params | arguments to pass to the <code>pageFunction</code>. |
**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';
(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
);
```