fix: fix circularity on JSHandle interface (#9661)

puppeteer · Feb 13, 2023 · eb13863 · eb13863
1 parent d2b46d5
commit eb13863
Show file tree

Hide file tree

Showing 19 changed files with 169 additions and 166 deletions.
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -149,6 +149,7 @@ sidebar_label: API
 | [ElementFor](./puppeteer.elementfor.md)                                   |                                                                                                                                                         |
 | [ErrorCode](./puppeteer.errorcode.md)                                     |                                                                                                                                                         |
 | [EvaluateFunc](./puppeteer.evaluatefunc.md)                               |                                                                                                                                                         |
+| [EvaluateFuncWith](./puppeteer.evaluatefuncwith.md)                       |                                                                                                                                                         |
 | [EventType](./puppeteer.eventtype.md)                                     |                                                                                                                                                         |
 | [FlattenHandle](./puppeteer.flattenhandle.md)                             |                                                                                                                                                         |
 | [HandleFor](./puppeteer.handlefor.md)                                     |                                                                                                                                                         |

diff --git a/docs/api/puppeteer.elementhandle.__eval.md b/docs/api/puppeteer.elementhandle.__eval.md
@@ -15,9 +15,10 @@ class ElementHandle {
   $$eval<
     Selector extends string,
     Params extends unknown[],
-    Func extends EvaluateFunc<
-      [HandleFor<Array<NodeFor<Selector>>>, ...Params]
-    > = EvaluateFunc<[HandleFor<Array<NodeFor<Selector>>>, ...Params]>
+    Func extends EvaluateFuncWith<
+      Array<NodeFor<Selector>>,
+      Params
+    > = EvaluateFuncWith<Array<NodeFor<Selector>>, Params>
   >(
     selector: Selector,
     pageFunction: Func | string,

diff --git a/docs/api/puppeteer.elementhandle._eval.md b/docs/api/puppeteer.elementhandle._eval.md
@@ -15,9 +15,10 @@ class ElementHandle {
   $eval<
     Selector extends string,
     Params extends unknown[],
-    Func extends EvaluateFunc<
-      [ElementHandle<NodeFor<Selector>>, ...Params]
-    > = EvaluateFunc<[ElementHandle<NodeFor<Selector>>, ...Params]>
+    Func extends EvaluateFuncWith<NodeFor<Selector>, Params> = EvaluateFuncWith<
+      NodeFor<Selector>,
+      Params
+    >
   >(
     selector: Selector,
     pageFunction: Func | string,

diff --git a/docs/api/puppeteer.evaluatefuncwith.md b/docs/api/puppeteer.evaluatefuncwith.md
@@ -0,0 +1,15 @@
+---
+sidebar_label: EvaluateFuncWith
+---
+
+# EvaluateFuncWith type
+
+#### Signature:
+
+```typescript
+export type EvaluateFuncWith<V, T extends unknown[]> = (
+  ...params: [V, ...InnerParams<T>]
+) => Awaitable<unknown>;
+```
+
+**References:** [InnerParams](./puppeteer.innerparams.md), [Awaitable](./puppeteer.awaitable.md)
diff --git a/docs/api/puppeteer.frame.__eval.md b/docs/api/puppeteer.frame.__eval.md
@@ -15,9 +15,10 @@ class Frame {
   $$eval<
     Selector extends string,
     Params extends unknown[],
-    Func extends EvaluateFunc<
-      [Array<NodeFor<Selector>>, ...Params]
-    > = EvaluateFunc<[Array<NodeFor<Selector>>, ...Params]>
+    Func extends EvaluateFuncWith<
+      Array<NodeFor<Selector>>,
+      Params
+    > = EvaluateFuncWith<Array<NodeFor<Selector>>, Params>
   >(
     selector: Selector,
     pageFunction: Func | string,

diff --git a/docs/api/puppeteer.frame._eval.md b/docs/api/puppeteer.frame._eval.md
@@ -15,9 +15,10 @@ class Frame {
   $eval<
     Selector extends string,
     Params extends unknown[],
-    Func extends EvaluateFunc<
-      [ElementHandle<NodeFor<Selector>>, ...Params]
-    > = EvaluateFunc<[ElementHandle<NodeFor<Selector>>, ...Params]>
+    Func extends EvaluateFuncWith<NodeFor<Selector>, Params> = EvaluateFuncWith<
+      NodeFor<Selector>,
+      Params
+    >
   >(
     selector: Selector,
     pageFunction: Func | string,

diff --git a/docs/api/puppeteer.jshandle.evaluate.md b/docs/api/puppeteer.jshandle.evaluate.md
@@ -12,9 +12,7 @@ Evaluates the given function with the current handle as its first argument.
 class JSHandle {
   evaluate<
     Params extends unknown[],
-    Func extends EvaluateFunc<[this, ...Params]> = EvaluateFunc<
-      [this, ...Params]
-    >
+    Func extends EvaluateFuncWith<T, Params> = EvaluateFuncWith<T, Params>
   >(
     pageFunction: Func | string,
     ...args: Params

diff --git a/docs/api/puppeteer.jshandle.evaluatehandle.md b/docs/api/puppeteer.jshandle.evaluatehandle.md
@@ -12,9 +12,7 @@ Evaluates the given function with the current handle as its first argument.
 class JSHandle {
   evaluateHandle<
     Params extends unknown[],
-    Func extends EvaluateFunc<[this, ...Params]> = EvaluateFunc<
-      [this, ...Params]
-    >
+    Func extends EvaluateFuncWith<T, Params> = EvaluateFuncWith<T, Params>
   >(
     pageFunction: Func | string,
     ...args: Params

diff --git a/docs/api/puppeteer.page.__eval.md b/docs/api/puppeteer.page.__eval.md
@@ -13,9 +13,10 @@ class Page {
   $$eval<
     Selector extends string,
     Params extends unknown[],
-    Func extends EvaluateFunc<
-      [Array<NodeFor<Selector>>, ...Params]
-    > = EvaluateFunc<[Array<NodeFor<Selector>>, ...Params]>
+    Func extends EvaluateFuncWith<
+      Array<NodeFor<Selector>>,
+      Params
+    > = EvaluateFuncWith<Array<NodeFor<Selector>>, Params>
   >(
     selector: Selector,
     pageFunction: Func | string,

diff --git a/docs/api/puppeteer.page._eval.md b/docs/api/puppeteer.page._eval.md
@@ -13,9 +13,10 @@ class Page {
   $eval<
     Selector extends string,
     Params extends unknown[],
-    Func extends EvaluateFunc<
-      [ElementHandle<NodeFor<Selector>>, ...Params]
-    > = EvaluateFunc<[ElementHandle<NodeFor<Selector>>, ...Params]>
+    Func extends EvaluateFuncWith<NodeFor<Selector>, Params> = EvaluateFuncWith<
+      NodeFor<Selector>,
+      Params
+    >
   >(
     selector: Selector,
     pageFunction: Func | string,

diff --git a/packages/puppeteer-core/src/api/ElementHandle.ts b/packages/puppeteer-core/src/api/ElementHandle.ts
@@ -15,15 +15,20 @@
  */
 
 import {Protocol} from 'devtools-protocol';
+import {CDPSession} from '../common/Connection.js';
+import {ExecutionContext} from '../common/ExecutionContext.js';
 import {Frame} from '../common/Frame.js';
+import {MouseButton} from '../common/Input.js';
 import {WaitForSelectorOptions} from '../common/IsolatedWorld.js';
+import {
+  ElementFor,
+  EvaluateFuncWith,
+  HandleFor,
+  NodeFor,
+} from '../common/types.js';
+import {KeyInput} from '../common/USKeyboardLayout.js';
 import {JSHandle} from './JSHandle.js';
 import {ScreenshotOptions} from './Page.js';
-import {ElementFor, EvaluateFunc, HandleFor, NodeFor} from '../common/types.js';
-import {KeyInput} from '../common/USKeyboardLayout.js';
-import {MouseButton} from '../common/Input.js';
-import {ExecutionContext} from '../common/ExecutionContext.js';
-import {CDPSession} from '../common/Connection.js';
 
 /**
  * @public
@@ -234,21 +239,16 @@ export class ElementHandle<
   async $eval<
     Selector extends string,
     Params extends unknown[],
-    Func extends EvaluateFunc<
-      [ElementHandle<NodeFor<Selector>>, ...Params]
-    > = EvaluateFunc<[ElementHandle<NodeFor<Selector>>, ...Params]>
+    Func extends EvaluateFuncWith<NodeFor<Selector>, Params> = EvaluateFuncWith<
+      NodeFor<Selector>,
+      Params
+    >
   >(
     selector: Selector,
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>>;
-  async $eval<
-    Selector extends string,
-    Params extends unknown[],
-    Func extends EvaluateFunc<
-      [ElementHandle<NodeFor<Selector>>, ...Params]
-    > = EvaluateFunc<[ElementHandle<NodeFor<Selector>>, ...Params]>
-  >(): Promise<Awaited<ReturnType<Func>>> {
+  async $eval(): Promise<unknown> {
     throw new Error('Not implemented');
   }
 
@@ -288,21 +288,16 @@ export class ElementHandle<
   async $$eval<
     Selector extends string,
     Params extends unknown[],
-    Func extends EvaluateFunc<
-      [HandleFor<Array<NodeFor<Selector>>>, ...Params]
-    > = EvaluateFunc<[HandleFor<Array<NodeFor<Selector>>>, ...Params]>
+    Func extends EvaluateFuncWith<
+      Array<NodeFor<Selector>>,
+      Params
+    > = EvaluateFuncWith<Array<NodeFor<Selector>>, Params>
   >(
     selector: Selector,
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>>;
-  async $$eval<
-    Selector extends string,
-    Params extends unknown[],
-    Func extends EvaluateFunc<
-      [HandleFor<Array<NodeFor<Selector>>>, ...Params]
-    > = EvaluateFunc<[HandleFor<Array<NodeFor<Selector>>>, ...Params]>
-  >(): Promise<Awaited<ReturnType<Func>>> {
+  async $$eval(): Promise<unknown> {
     throw new Error('Not implemented');
   }
 

diff --git a/packages/puppeteer-core/src/api/JSHandle.ts b/packages/puppeteer-core/src/api/JSHandle.ts
@@ -15,10 +15,10 @@
  */
 
 import Protocol from 'devtools-protocol';
-import {ElementHandle} from './ElementHandle.js';
-import {EvaluateFunc, HandleFor, HandleOr} from '../common/types.js';
-import {ExecutionContext} from '../common/ExecutionContext.js';
 import {CDPSession} from '../common/Connection.js';
+import {ExecutionContext} from '../common/ExecutionContext.js';
+import {EvaluateFuncWith, HandleFor, HandleOr} from '../common/types.js';
+import {ElementHandle} from './ElementHandle.js';
 
 declare const __JSHandleSymbol: unique symbol;
 
@@ -80,19 +80,12 @@ export class JSHandle<T = unknown> {
    */
   async evaluate<
     Params extends unknown[],
-    Func extends EvaluateFunc<[this, ...Params]> = EvaluateFunc<
-      [this, ...Params]
-    >
+    Func extends EvaluateFuncWith<T, Params> = EvaluateFuncWith<T, Params>
   >(
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>>;
-  async evaluate<
-    Params extends unknown[],
-    Func extends EvaluateFunc<[this, ...Params]> = EvaluateFunc<
-      [this, ...Params]
-    >
-  >(): Promise<Awaited<ReturnType<Func>>> {
+  async evaluate(): Promise<unknown> {
     throw new Error('Not implemented');
   }
 
@@ -102,19 +95,12 @@ export class JSHandle<T = unknown> {
    */
   async evaluateHandle<
     Params extends unknown[],
-    Func extends EvaluateFunc<[this, ...Params]> = EvaluateFunc<
-      [this, ...Params]
-    >
+    Func extends EvaluateFuncWith<T, Params> = EvaluateFuncWith<T, Params>
   >(
     pageFunction: Func | string,
     ...args: Params
   ): Promise<HandleFor<Awaited<ReturnType<Func>>>>;
-  async evaluateHandle<
-    Params extends unknown[],
-    Func extends EvaluateFunc<[this, ...Params]> = EvaluateFunc<
-      [this, ...Params]
-    >
-  >(): Promise<HandleFor<Awaited<ReturnType<Func>>>> {
+  async evaluateHandle(): Promise<HandleFor<unknown>> {
     throw new Error('Not implemented');
   }
 

diff --git a/packages/puppeteer-core/src/api/Page.ts b/packages/puppeteer-core/src/api/Page.ts
@@ -21,7 +21,6 @@ import type {ConsoleMessage} from '../common/ConsoleMessage.js';
 import type {Coverage} from '../common/Coverage.js';
 import {Device} from '../common/Device.js';
 import type {Dialog} from '../common/Dialog.js';
-import type {ElementHandle} from './ElementHandle.js';
 import {EventEmitter, Handler} from '../common/EventEmitter.js';
 import type {FileChooser} from '../common/FileChooser.js';
 import type {
@@ -39,17 +38,23 @@ import type {
   Touchscreen,
 } from '../common/Input.js';
 import type {WaitForSelectorOptions} from '../common/IsolatedWorld.js';
-import type {JSHandle} from './JSHandle.js';
 import type {PuppeteerLifeCycleEvent} from '../common/LifecycleWatcher.js';
 import type {Credentials, NetworkConditions} from '../common/NetworkManager.js';
 import type {PDFOptions} from '../common/PDFOptions.js';
 import type {Viewport} from '../common/PuppeteerViewport.js';
 import type {Target} from '../common/Target.js';
 import type {Tracing} from '../common/Tracing.js';
-import type {EvaluateFunc, HandleFor, NodeFor} from '../common/types.js';
+import type {
+  EvaluateFunc,
+  EvaluateFuncWith,
+  HandleFor,
+  NodeFor,
+} from '../common/types.js';
 import type {WebWorker} from '../common/WebWorker.js';
 import type {Browser} from './Browser.js';
 import type {BrowserContext} from './BrowserContext.js';
+import type {ElementHandle} from './ElementHandle.js';
+import type {JSHandle} from './JSHandle.js';
 
 /**
  * @public
@@ -956,21 +961,16 @@ export class Page extends EventEmitter {
   async $eval<
     Selector extends string,
     Params extends unknown[],
-    Func extends EvaluateFunc<
-      [ElementHandle<NodeFor<Selector>>, ...Params]
-    > = EvaluateFunc<[ElementHandle<NodeFor<Selector>>, ...Params]>
+    Func extends EvaluateFuncWith<NodeFor<Selector>, Params> = EvaluateFuncWith<
+      NodeFor<Selector>,
+      Params
+    >
   >(
     selector: Selector,
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>>;
-  async $eval<
-    Selector extends string,
-    Params extends unknown[],
-    Func extends EvaluateFunc<
-      [ElementHandle<NodeFor<Selector>>, ...Params]
-    > = EvaluateFunc<[ElementHandle<NodeFor<Selector>>, ...Params]>
-  >(): Promise<Awaited<ReturnType<Func>>> {
+  async $eval(): Promise<unknown> {
     throw new Error('Not implemented');
   }
 
@@ -1039,21 +1039,16 @@ export class Page extends EventEmitter {
   async $$eval<
     Selector extends string,
     Params extends unknown[],
-    Func extends EvaluateFunc<
-      [Array<NodeFor<Selector>>, ...Params]
-    > = EvaluateFunc<[Array<NodeFor<Selector>>, ...Params]>
+    Func extends EvaluateFuncWith<
+      Array<NodeFor<Selector>>,
+      Params
+    > = EvaluateFuncWith<Array<NodeFor<Selector>>, Params>
   >(
     selector: Selector,
     pageFunction: Func | string,
     ...args: Params
   ): Promise<Awaited<ReturnType<Func>>>;
-  async $$eval<
-    Selector extends string,
-    Params extends unknown[],
-    Func extends EvaluateFunc<
-      [Array<NodeFor<Selector>>, ...Params]
-    > = EvaluateFunc<[Array<NodeFor<Selector>>, ...Params]>
-  >(): Promise<Awaited<ReturnType<Func>>> {
+  async $$eval(): Promise<unknown> {
     throw new Error('Not implemented');
   }