puppeteer/docs/api/puppeteer.frame._eval.md

49 lines
1.7 KiB
Markdown
Raw Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: Frame.$eval
---
# Frame.$eval() method
Runs the given function on the first element matching the given selector in the frame.
If the given function returns a promise, then this method will wait till the promise resolves.
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class Frame {
$eval<
Selector extends string,
2022-07-05 13:41:43 +00:00
Params extends unknown[],
Func extends EvaluateFuncWith<NodeFor<Selector>, Params> = EvaluateFuncWith<
NodeFor<Selector>,
Params
>,
2022-07-05 13:41:43 +00:00
>(
selector: Selector,
2023-08-30 11:09:27 +00:00
pageFunction: string | Func,
2022-07-05 13:41:43 +00:00
...args: Params
): Promise<Awaited<ReturnType<Func>>>;
}
```
## Parameters
| Parameter | Type | Description |
| ------------ | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| selector | Selector | The selector to query for. |
2023-08-30 11:09:27 +00:00
| pageFunction | string \| Func | The function to be evaluated in the frame's context. The first element matching the selector will be passed to the function as its first argument. |
| args | Params | Additional arguments to pass to <code>pageFunction</code>. |
2022-07-05 13:41:43 +00:00
**Returns:**
Promise&lt;Awaited&lt;ReturnType&lt;Func&gt;&gt;&gt;
A promise to the result of the function.
2022-07-05 13:41:43 +00:00
## Example
```ts
const searchValue = await frame.$eval('#search', el => el.value);
```