2022-07-05 13:41:43 +00:00
|
|
|
---
|
|
|
|
sidebar_label: Page.waitForFunction
|
|
|
|
---
|
|
|
|
|
|
|
|
# Page.waitForFunction() method
|
|
|
|
|
2023-12-28 04:11:58 +00:00
|
|
|
Waits for the provided function, `pageFunction`, to return a truthy value when evaluated in the page's context.
|
2022-07-05 13:41:43 +00:00
|
|
|
|
2022-10-24 07:07:05 +00:00
|
|
|
#### Signature:
|
2022-07-05 13:41:43 +00:00
|
|
|
|
|
|
|
```typescript
|
|
|
|
class Page {
|
|
|
|
waitForFunction<
|
|
|
|
Params extends unknown[],
|
2023-07-17 08:52:54 +00:00
|
|
|
Func extends EvaluateFunc<Params> = EvaluateFunc<Params>,
|
2022-07-05 13:41:43 +00:00
|
|
|
>(
|
|
|
|
pageFunction: Func | string,
|
2022-09-15 06:22:20 +00:00
|
|
|
options?: FrameWaitForFunctionOptions,
|
2022-07-05 13:41:43 +00:00
|
|
|
...args: Params
|
|
|
|
): Promise<HandleFor<Awaited<ReturnType<Func>>>>;
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Parameters
|
|
|
|
|
2024-03-20 15:03:14 +00:00
|
|
|
<table><thead><tr><th>
|
2022-07-05 13:41:43 +00:00
|
|
|
|
2024-03-20 15:03:14 +00:00
|
|
|
Parameter
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Type
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
|
|
|
</th></tr></thead>
|
|
|
|
<tbody><tr><td>
|
|
|
|
|
|
|
|
pageFunction
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Func \| string
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Function to be evaluated in browser context until it returns a truthy value.
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
options
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[FrameWaitForFunctionOptions](./puppeteer.framewaitforfunctionoptions.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
_(Optional)_ Options for configuring waiting behavior.
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
args
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Params
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
</tbody></table>
|
2022-07-05 13:41:43 +00:00
|
|
|
**Returns:**
|
|
|
|
|
|
|
|
Promise<[HandleFor](./puppeteer.handlefor.md)<Awaited<ReturnType<Func>>>>
|
|
|
|
|
|
|
|
## Example 1
|
|
|
|
|
2023-12-28 04:11:58 +00:00
|
|
|
[Page.waitForFunction()](./puppeteer.page.waitforfunction.md) can be used to observe a viewport size change:
|
2022-07-05 13:41:43 +00:00
|
|
|
|
|
|
|
```ts
|
2022-12-09 12:57:39 +00:00
|
|
|
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.waitForFunction('window.innerWidth < 100');
|
|
|
|
await page.setViewport({width: 50, height: 50});
|
|
|
|
await watchDog;
|
|
|
|
await browser.close();
|
|
|
|
})();
|
|
|
|
```
|
|
|
|
|
|
|
|
## Example 2
|
|
|
|
|
2023-12-28 04:11:58 +00:00
|
|
|
Arguments can be passed from Node.js to `pageFunction`:
|
2022-07-05 13:41:43 +00:00
|
|
|
|
|
|
|
```ts
|
|
|
|
const selector = '.foo';
|
|
|
|
await page.waitForFunction(
|
|
|
|
selector => !!document.querySelector(selector),
|
|
|
|
{},
|
|
|
|
selector
|
|
|
|
);
|
|
|
|
```
|
|
|
|
|
|
|
|
## Example 3
|
|
|
|
|
2023-12-28 04:11:58 +00:00
|
|
|
The provided `pageFunction` can be asynchronous:
|
2022-07-05 13:41:43 +00:00
|
|
|
|
|
|
|
```ts
|
|
|
|
const username = 'github-username';
|
|
|
|
await page.waitForFunction(
|
|
|
|
async username => {
|
|
|
|
const githubResponse = await fetch(
|
|
|
|
`https://api.github.com/users/${username}`
|
|
|
|
);
|
|
|
|
const githubUser = await githubResponse.json();
|
|
|
|
// show the avatar
|
|
|
|
const img = document.createElement('img');
|
|
|
|
img.src = githubUser.avatar_url;
|
|
|
|
// wait 3 seconds
|
|
|
|
await new Promise((resolve, reject) => setTimeout(resolve, 3000));
|
|
|
|
img.remove();
|
|
|
|
},
|
|
|
|
{},
|
|
|
|
username
|
|
|
|
);
|
|
|
|
```
|