chore: remove docusaurus metadata from README.md (#8624)

This commit is contained in:
jrandolf
2022-07-05 14:42:31 +02:00
committed by GitHub
parent fc77c1517f
commit 45eb2c607f
728 changed files with 15375 additions and 17493 deletions

View File

@@ -1,47 +1,39 @@
---
sidebar_label: Frame.$eval
---
# Frame.$eval() method
**Signature:**
```typescript
class Frame {
$eval<
Selector extends keyof HTMLElementTagNameMap,
Params extends unknown[],
Func extends EvaluateFunc<
[HTMLElementTagNameMap[Selector], ...Params]
> = EvaluateFunc<[HTMLElementTagNameMap[Selector], ...Params]>
>(
selector: Selector,
pageFunction: Func | string,
...args: Params
): Promise<Awaited<ReturnType<Func>>>;
}
```
## Parameters
| Parameter | Type | Description |
| ------------ | -------------- | --------------------------------------------------------- |
| selector | Selector | the selector to query for |
| pageFunction | Func \| string | the function to be evaluated in the frame's context |
| args | Params | additional arguments to pass to <code>pageFunction</code> |
**Returns:**
Promise&lt;Awaited&lt;ReturnType&lt;Func&gt;&gt;&gt;
## 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
```ts
const searchValue = await frame.$eval('#search', el => el.value);
```
---
sidebar_label: Frame.$eval
---
# Frame.$eval() method
**Signature:**
```typescript
class Frame {$eval<Selector extends keyof HTMLElementTagNameMap, Params extends unknown[], Func extends EvaluateFunc<[
HTMLElementTagNameMap[Selector],
...Params
]> = EvaluateFunc<[HTMLElementTagNameMap[Selector], ...Params]>>(selector: Selector, pageFunction: Func | string, ...args: Params): Promise<Awaited<ReturnType<Func>>>;}
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| selector | Selector | the selector to query for |
| pageFunction | Func \| string | the function to be evaluated in the frame's context |
| args | Params | additional arguments to pass to <code>pageFunction</code> |
**Returns:**
Promise&lt;Awaited&lt;ReturnType&lt;Func&gt;&gt;&gt;
## 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
```ts
const searchValue = await frame.$eval('#search', el => el.value);
```