feat(types): improve typing of .evaluate() (#6096)

* feat(types): improve typing of `.evaluate()`

This is the start of the work to take the types from the
`@types/puppeteer` repository and port them into our repo so we can ship
our built-in types out the box.

This change types the `evaluate` function properly. It takes a generic
type which is the type of the function you're passing, and the arguments
and the return that you get back from the `evaluate` call are typed
correctly.
This commit is contained in:
Jack Franklin
2020-06-25 13:38:01 +01:00
committed by GitHub
parent a4d12a2b21
commit 46fc6ca41a
22 changed files with 264 additions and 96 deletions

View File

@@ -7,7 +7,7 @@
<b>Signature:</b>
```typescript
$$eval<ReturnType extends any>(selector: string, pageFunction: Function | string, ...args: unknown[]): Promise<ReturnType>;
$$eval<ReturnType extends any>(selector: string, pageFunction: EvaluateFn | string, ...args: SerializableOrJSHandle[]): Promise<ReturnType>;
```
## Parameters
@@ -15,8 +15,8 @@ $$eval<ReturnType extends any>(selector: string, pageFunction: Function | string
| Parameter | Type | Description |
| --- | --- | --- |
| selector | string | |
| pageFunction | Function \| string | |
| args | unknown\[\] | |
| pageFunction | [EvaluateFn](./puppeteer.evaluatefn.md) \| string | |
| args | [SerializableOrJSHandle](./puppeteer.serializableorjshandle.md)<!-- -->\[\] | |
<b>Returns:</b>