24cb6a28ad
* chore: document Frame class
39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Frame](./puppeteer.frame.md) > [$eval](./puppeteer.frame._eval.md)
|
|
|
|
## Frame.$eval() method
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
$eval<ReturnType>(selector: string, pageFunction: (element: Element, ...args: unknown[]) => ReturnType | Promise<ReturnType>, ...args: SerializableOrJSHandle[]): Promise<WrapElementHandle<ReturnType>>;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| selector | string | the selector to query for |
|
|
| pageFunction | (element: Element, ...args: unknown\[\]) => ReturnType \| Promise<ReturnType> | the function to be evaluated in the frame's context |
|
|
| args | [SerializableOrJSHandle](./puppeteer.serializableorjshandle.md)<!-- -->\[\] | additional arguments to pass to <code>pageFuncton</code> |
|
|
|
|
<b>Returns:</b>
|
|
|
|
Promise<[WrapElementHandle](./puppeteer.wrapelementhandle.md)<!-- --><ReturnType>>
|
|
|
|
## Remarks
|
|
|
|
This method runs `document.querySelector` within the frame and passes it as the first argument to `pageFunction`<!-- -->.
|
|
|
|
If `pageFunction` returns a Promise, then `frame.$eval` would wait for the promise to resolve and return its value.
|
|
|
|
## Example
|
|
|
|
|
|
```js
|
|
const searchValue = await frame.$eval('#search', el => el.value);
|
|
|
|
```
|
|
|