chore: update docs

puppeteer · Jul 5, 2022 · b965ef3 · b965ef3
1 parent 0fc2aac
commit b965ef3
Show file tree

Hide file tree

Showing 49 changed files with 200 additions and 169 deletions.
diff --git a/docs/api/puppeteer.customqueryhandler.md b/docs/api/puppeteer.customqueryhandler.md
@@ -14,7 +14,7 @@ export interface CustomQueryHandler
 
 ## Properties
 
-| Property                                                | Modifiers | Type                                                                                            | Description       |
-| ------------------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------- | ----------------- |
-| [queryAll?](./puppeteer.customqueryhandler.queryall.md) |           | (element: Element \| Document, selector: string) =&gt; Element\[\] \| NodeListOf&lt;Element&gt; | <i>(Optional)</i> |
-| [queryOne?](./puppeteer.customqueryhandler.queryone.md) |           | (element: Element \| Document, selector: string) =&gt; Element \| null                          | <i>(Optional)</i> |
+| Property                                                | Modifiers | Type                                                      | Description       |
+| ------------------------------------------------------- | --------- | --------------------------------------------------------- | ----------------- |
+| [queryAll?](./puppeteer.customqueryhandler.queryall.md) |           | (element: Node, selector: string) =&gt; Array&lt;Node&gt; | <i>(Optional)</i> |
+| [queryOne?](./puppeteer.customqueryhandler.queryone.md) |           | (element: Node, selector: string) =&gt; Node \| null      | <i>(Optional)</i> |
diff --git a/docs/api/puppeteer.customqueryhandler.queryall.md b/docs/api/puppeteer.customqueryhandler.queryall.md
@@ -8,9 +8,6 @@ sidebar_label: CustomQueryHandler.queryAll
 
 ```typescript
 interface CustomQueryHandler {
-  queryAll?: (
-    element: Element | Document,
-    selector: string
-  ) => Element[] | NodeListOf<Element>;
+  queryAll?: (element: Node, selector: string) => Array<Node>;
 }
 ```
diff --git a/docs/api/puppeteer.customqueryhandler.queryone.md b/docs/api/puppeteer.customqueryhandler.queryone.md
@@ -8,6 +8,6 @@ sidebar_label: CustomQueryHandler.queryOne
 
 ```typescript
 interface CustomQueryHandler {
-  queryOne?: (element: Element | Document, selector: string) => Element | null;
+  queryOne?: (element: Node, selector: string) => Node | null;
 }
 ```
diff --git a/docs/api/puppeteer.elementhandle.__1.md b/docs/api/puppeteer.elementhandle.__1.md
@@ -8,7 +8,7 @@ sidebar_label: ElementHandle.$_1
 
 ```typescript
 class ElementHandle {
-  $(selector: string): Promise<ElementHandle | null>;
+  $(selector: string): Promise<ElementHandle<Node> | null>;
 }
 ```
 
@@ -20,4 +20,4 @@ class ElementHandle {
 
 **Returns:**
 
-Promise&lt;[ElementHandle](./puppeteer.elementhandle.md) \| null&gt;
+Promise&lt;[ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt; \| null&gt;
diff --git a/docs/api/puppeteer.elementhandle.___1.md b/docs/api/puppeteer.elementhandle.___1.md
@@ -8,7 +8,7 @@ sidebar_label: ElementHandle.$$_1
 
 ```typescript
 class ElementHandle {
-  $$(selector: string): Promise<ElementHandle[]>;
+  $$(selector: string): Promise<ElementHandle<Node>[]>;
 }
 ```
 
@@ -20,4 +20,4 @@ class ElementHandle {
 
 **Returns:**
 
-Promise&lt;[ElementHandle](./puppeteer.elementhandle.md)\[\]&gt;
+Promise&lt;[ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt;\[\]&gt;
diff --git a/docs/api/puppeteer.elementhandle.__eval_1.md b/docs/api/puppeteer.elementhandle.__eval_1.md
@@ -10,8 +10,8 @@ sidebar_label: ElementHandle.$$eval_1
 class ElementHandle {
   $$eval<
     Params extends unknown[],
-    Func extends EvaluateFunc<[Element[], ...Params]> = EvaluateFunc<
-      [Element[], ...Params]
+    Func extends EvaluateFunc<[Node[], ...Params]> = EvaluateFunc<
+      [Node[], ...Params]
     >
   >(
     selector: string,

diff --git a/docs/api/puppeteer.elementhandle._eval_1.md b/docs/api/puppeteer.elementhandle._eval_1.md
@@ -10,8 +10,8 @@ sidebar_label: ElementHandle.$eval_1
 class ElementHandle {
   $eval<
     Params extends unknown[],
-    Func extends EvaluateFunc<[Element, ...Params]> = EvaluateFunc<
-      [Element, ...Params]
+    Func extends EvaluateFunc<[Node, ...Params]> = EvaluateFunc<
+      [Node, ...Params]
     >
   >(
     selector: string,

diff --git a/docs/api/puppeteer.elementhandle._x.md b/docs/api/puppeteer.elementhandle._x.md
@@ -10,7 +10,7 @@ The method evaluates the XPath expression relative to the elementHandle. If ther
 
 ```typescript
 class ElementHandle {
-  $x(expression: string): Promise<ElementHandle[]>;
+  $x(expression: string): Promise<ElementHandle<Node>[]>;
 }
 ```
 
@@ -22,4 +22,4 @@ class ElementHandle {
 
 **Returns:**
 
-Promise&lt;[ElementHandle](./puppeteer.elementhandle.md)\[\]&gt;
+Promise&lt;[ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt;\[\]&gt;
diff --git a/docs/api/puppeteer.elementhandle.click.md b/docs/api/puppeteer.elementhandle.click.md
@@ -10,15 +10,16 @@ This method scrolls element into view if needed, and then uses [Page.mouse](./pu
 
 ```typescript
 class ElementHandle {
-  click(options?: ClickOptions): Promise<void>;
+  click(this: ElementHandle<Element>, options?: ClickOptions): Promise<void>;
 }
 ```
 
 ## Parameters
 
-| Parameter | Type                                        | Description       |
-| --------- | ------------------------------------------- | ----------------- |
-| options   | [ClickOptions](./puppeteer.clickoptions.md) | <i>(Optional)</i> |
+| Parameter | Type                                                         | Description       |
+| --------- | ------------------------------------------------------------ | ----------------- |
+| this      | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; |                   |
+| options   | [ClickOptions](./puppeteer.clickoptions.md)                  | <i>(Optional)</i> |
 
 **Returns:**
 

diff --git a/docs/api/puppeteer.elementhandle.drag.md b/docs/api/puppeteer.elementhandle.drag.md
@@ -10,15 +10,19 @@ This method creates and captures a dragevent from the element.
 
 ```typescript
 class ElementHandle {
-  drag(target: Point): Promise<Protocol.Input.DragData>;
+  drag(
+    this: ElementHandle<Element>,
+    target: Point
+  ): Promise<Protocol.Input.DragData>;
 }
 ```
 
 ## Parameters
 
-| Parameter | Type                          | Description |
-| --------- | ----------------------------- | ----------- |
-| target    | [Point](./puppeteer.point.md) |             |
+| Parameter | Type                                                         | Description |
+| --------- | ------------------------------------------------------------ | ----------- |
+| this      | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; |             |
+| target    | [Point](./puppeteer.point.md)                                |             |
 
 **Returns:**
 

diff --git a/docs/api/puppeteer.elementhandle.draganddrop.md b/docs/api/puppeteer.elementhandle.draganddrop.md
@@ -11,7 +11,8 @@ This method triggers a dragenter, dragover, and drop on the element.
 ```typescript
 class ElementHandle {
   dragAndDrop(
-    target: ElementHandle,
+    this: ElementHandle<Element>,
+    target: ElementHandle<Node>,
     options?: {
       delay: number;
     }
@@ -21,10 +22,11 @@ class ElementHandle {
 
 ## Parameters
 
-| Parameter | Type                                          | Description       |
-| --------- | --------------------------------------------- | ----------------- |
-| target    | [ElementHandle](./puppeteer.elementhandle.md) |                   |
-| options   | { delay: number; }                            | <i>(Optional)</i> |
+| Parameter | Type                                                         | Description       |
+| --------- | ------------------------------------------------------------ | ----------------- |
+| this      | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; |                   |
+| target    | [ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt;    |                   |
+| options   | { delay: number; }                                           | <i>(Optional)</i> |
 
 **Returns:**
 

diff --git a/docs/api/puppeteer.elementhandle.dragenter.md b/docs/api/puppeteer.elementhandle.dragenter.md
@@ -10,15 +10,19 @@ This method creates a `dragenter` event on the element.
 
 ```typescript
 class ElementHandle {
-  dragEnter(data?: Protocol.Input.DragData): Promise<void>;
+  dragEnter(
+    this: ElementHandle<Element>,
+    data?: Protocol.Input.DragData
+  ): Promise<void>;
 }
 ```
 
 ## Parameters
 
-| Parameter | Type                    | Description       |
-| --------- | ----------------------- | ----------------- |
-| data      | Protocol.Input.DragData | <i>(Optional)</i> |
+| Parameter | Type                                                         | Description       |
+| --------- | ------------------------------------------------------------ | ----------------- |
+| this      | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; |                   |
+| data      | Protocol.Input.DragData                                      | <i>(Optional)</i> |
 
 **Returns:**
 

diff --git a/docs/api/puppeteer.elementhandle.dragover.md b/docs/api/puppeteer.elementhandle.dragover.md
@@ -10,15 +10,19 @@ This method creates a `dragover` event on the element.
 
 ```typescript
 class ElementHandle {
-  dragOver(data?: Protocol.Input.DragData): Promise<void>;
+  dragOver(
+    this: ElementHandle<Element>,
+    data?: Protocol.Input.DragData
+  ): Promise<void>;
 }
 ```
 
 ## Parameters
 
-| Parameter | Type                    | Description       |
-| --------- | ----------------------- | ----------------- |
-| data      | Protocol.Input.DragData | <i>(Optional)</i> |
+| Parameter | Type                                                         | Description       |
+| --------- | ------------------------------------------------------------ | ----------------- |
+| this      | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; |                   |
+| data      | Protocol.Input.DragData                                      | <i>(Optional)</i> |
 
 **Returns:**
 

diff --git a/docs/api/puppeteer.elementhandle.drop.md b/docs/api/puppeteer.elementhandle.drop.md
@@ -10,15 +10,19 @@ This method triggers a drop on the element.
 
 ```typescript
 class ElementHandle {
-  drop(data?: Protocol.Input.DragData): Promise<void>;
+  drop(
+    this: ElementHandle<Element>,
+    data?: Protocol.Input.DragData
+  ): Promise<void>;
 }
 ```
 
 ## Parameters
 
-| Parameter | Type                    | Description       |
-| --------- | ----------------------- | ----------------- |
-| data      | Protocol.Input.DragData | <i>(Optional)</i> |
+| Parameter | Type                                                         | Description       |
+| --------- | ------------------------------------------------------------ | ----------------- |
+| this      | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; |                   |
+| data      | Protocol.Input.DragData                                      | <i>(Optional)</i> |
 
 **Returns:**
 

diff --git a/docs/api/puppeteer.elementhandle.hover.md b/docs/api/puppeteer.elementhandle.hover.md
@@ -10,10 +10,16 @@ This method scrolls element into view if needed, and then uses [Page.mouse](./pu
 
 ```typescript
 class ElementHandle {
-  hover(): Promise<void>;
+  hover(this: ElementHandle<Element>): Promise<void>;
 }
 ```
 
+## Parameters
+
+| Parameter | Type                                                         | Description |
+| --------- | ------------------------------------------------------------ | ----------- |
+| this      | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; |             |
+
 **Returns:**
 
 Promise&lt;void&gt;
diff --git a/docs/api/puppeteer.elementhandle.isintersectingviewport.md b/docs/api/puppeteer.elementhandle.isintersectingviewport.md
@@ -10,15 +10,21 @@ Resolves to true if the element is visible in the current viewport.
 
 ```typescript
 class ElementHandle {
-  isIntersectingViewport(options?: {threshold?: number}): Promise<boolean>;
+  isIntersectingViewport(
+    this: ElementHandle<Element>,
+    options?: {
+      threshold?: number;
+    }
+  ): Promise<boolean>;
 }
 ```
 
 ## Parameters
 
-| Parameter | Type                    | Description       |
-| --------- | ----------------------- | ----------------- |
-| options   | { threshold?: number; } | <i>(Optional)</i> |
+| Parameter | Type                                                         | Description       |
+| --------- | ------------------------------------------------------------ | ----------------- |
+| this      | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; |                   |
+| options   | { threshold?: number; }                                      | <i>(Optional)</i> |
 
 **Returns:**