mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
c4803e4a37
🤖 I have created a release *beep* *boop* --- <details><summary>ng-schematics: 0.1.0</summary> ## 0.1.0 (2022-11-23) ### Features * **ng-schematics:** Release @puppeteer/ng-schematics ([#9244](https://github.com/puppeteer/puppeteer/issues/9244)) ([be33929
](be33929770
)) </details> <details><summary>puppeteer: 19.3.0</summary> ## [19.3.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-v19.2.2...puppeteer-v19.3.0) (2022-11-23) ### Miscellaneous Chores * **puppeteer:** Synchronize puppeteer versions ### Dependencies * The following workspace dependencies were updated * dependencies * puppeteer-core bumped from 19.2.2 to 19.3.0 </details> <details><summary>puppeteer-core: 19.3.0</summary> ## [19.3.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v19.2.2...puppeteer-core-v19.3.0) (2022-11-23) ### Features * **puppeteer-core:** Infer element type from complex selector ([#9253](https://github.com/puppeteer/puppeteer/issues/9253)) ([bef1061
](bef1061c06
)) * **puppeteer-core:** update Chrome launcher flags ([#9239](https://github.com/puppeteer/puppeteer/issues/9239)) ([ae87bfc
](ae87bfc2b4
)) ### Bug Fixes * remove boundary conditions for visibility ([#9249](https://github.com/puppeteer/puppeteer/issues/9249)) ([e003513
](e003513c0c
)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
74 lines
2.3 KiB
Markdown
74 lines
2.3 KiB
Markdown
---
|
|
sidebar_label: Page.evaluateHandle
|
|
---
|
|
|
|
# Page.evaluateHandle() method
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
class Page {
|
|
evaluateHandle<
|
|
Params extends unknown[],
|
|
Func extends EvaluateFunc<Params> = EvaluateFunc<Params>
|
|
>(
|
|
pageFunction: Func | string,
|
|
...args: Params
|
|
): Promise<HandleFor<Awaited<ReturnType<Func>>>>;
|
|
}
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| ------------ | -------------- | ------------------------------------------ |
|
|
| pageFunction | Func \| string | a function that is run within the page |
|
|
| args | Params | arguments to be passed to the pageFunction |
|
|
|
|
**Returns:**
|
|
|
|
Promise<[HandleFor](./puppeteer.handlefor.md)<Awaited<ReturnType<Func>>>>
|
|
|
|
## Remarks
|
|
|
|
The only difference between [page.evaluate](./puppeteer.page.evaluate.md) and `page.evaluateHandle` is that `evaluateHandle` will return the value wrapped in an in-page object.
|
|
|
|
If the function passed to `page.evaluteHandle` returns a Promise, the function will wait for the promise to resolve and return its value.
|
|
|
|
You can pass a string instead of a function (although functions are recommended as they are easier to debug and use with TypeScript):
|
|
|
|
## Example 1
|
|
|
|
```ts
|
|
const aHandle = await page.evaluateHandle('document');
|
|
```
|
|
|
|
## Example 2
|
|
|
|
[JSHandle](./puppeteer.jshandle.md) instances can be passed as arguments to the `pageFunction`:
|
|
|
|
```ts
|
|
const aHandle = await page.evaluateHandle(() => document.body);
|
|
const resultHandle = await page.evaluateHandle(body => body.innerHTML, aHandle);
|
|
console.log(await resultHandle.jsonValue());
|
|
await resultHandle.dispose();
|
|
```
|
|
|
|
Most of the time this function returns a [JSHandle](./puppeteer.jshandle.md), but if `pageFunction` returns a reference to an element, you instead get an [ElementHandle](./puppeteer.elementhandle.md) back:
|
|
|
|
## Example 3
|
|
|
|
```ts
|
|
const button = await page.evaluateHandle(() =>
|
|
document.querySelector('button')
|
|
);
|
|
// can call `click` because `button` is an `ElementHandle`
|
|
await button.click();
|
|
```
|
|
|
|
The TypeScript definitions assume that `evaluateHandle` returns a `JSHandle`, but if you know it's going to return an `ElementHandle`, pass it as the generic argument:
|
|
|
|
```ts
|
|
const button = await page.evaluateHandle<ElementHandle>(...);
|
|
```
|