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

96 lines
2.1 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
<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>
selector
</td><td>
Selector
</td><td>
[selector](https://pptr.dev/guides/page-interactions#query-selectors) to query page for. [CSS selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors) can be passed as-is and a [Puppeteer-specific seletor syntax](https://pptr.dev/guides/page-interactions#p-selectors) allows quering by [text](https://pptr.dev/guides/page-interactions#text-selectors--p-text), [a11y role and name](https://pptr.dev/guides/page-interactions#aria-selectors--p-aria), and [xpath](https://pptr.dev/guides/page-interactions#xpath-selectors--p-xpath) and [combining these queries across shadow roots](https://pptr.dev/guides/page-interactions#-and--combinators). Alternatively, you can specify a selector type using a prefix [prefix](https://pptr.dev/guides/page-interactions#built-in-selectors).
</td></tr>
<tr><td>
pageFunction
</td><td>
string \| Func
</td><td>
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.
</td></tr>
<tr><td>
args
</td><td>
Params
</td><td>
Additional arguments to pass to `pageFunction`.
</td></tr>
</tbody></table>
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);
```