mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
8370ec88ae
This change started as a small change to pull types from DefinitelyTyped over to
Puppeteer for the `evaluateHandle` function but instead ended up also fixing
what looks to be a long standing issue with our existing documentation.
`evaluateHandle` can in fact return an `ElementHandle` rather than a `JSHandle`.
Note that `ElementHandle` extends `JSHandle` so whilst the docs are technically
correct (all ElementHandles are JSHandles) it's confusing because JSHandles
don't have methods like `click` on them, but ElementHandles do.
if you return something that is an HTML element:
```
const button = page.evaluateHandle(() => document.querySelector('button'));
// this is an ElementHandle, not a JSHandle
```
Therefore I've updated the original docs and added a large explanation to the
TSDoc for `page.evaluateHandle`.
In TypeScript land we'll assume the function will return a `JSHandle` but you
can tell TS otherwise via the generic argument, which can only be `JSHandle`
(the default) or `ElementHandle`:
```
const button = page.evaluateHandle<ElementHandle>(() => document.querySelector('button'));
```
64 lines
1.3 KiB
TypeScript
64 lines
1.3 KiB
TypeScript
/**
|
|
* Copyright 2020 Google Inc. All rights reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { JSHandle } from './JSHandle';
|
|
|
|
/**
|
|
* @public
|
|
*/
|
|
export type EvaluateFn<T = any> = string | ((arg1: T, ...args: any[]) => any);
|
|
/**
|
|
* @public
|
|
*/
|
|
export type EvaluateFnReturnType<T extends EvaluateFn> = T extends (
|
|
...args: any[]
|
|
) => infer R
|
|
? R
|
|
: unknown;
|
|
|
|
/**
|
|
* @public
|
|
*/
|
|
export type EvaluateHandleFn = string | ((...args: unknown[]) => unknown);
|
|
|
|
/**
|
|
* @public
|
|
*/
|
|
export type Serializable =
|
|
| number
|
|
| string
|
|
| boolean
|
|
| null
|
|
| JSONArray
|
|
| JSONObject;
|
|
|
|
/**
|
|
* @public
|
|
*/
|
|
export type JSONArray = Serializable[];
|
|
|
|
/**
|
|
* @public
|
|
*/
|
|
export interface JSONObject {
|
|
[key: string]: Serializable;
|
|
}
|
|
|
|
/**
|
|
* @public
|
|
*/
|
|
export type SerializableOrJSHandle = Serializable | JSHandle;
|