chore(docs): mark JSHandle properties as internal (#6126)

puppeteer · Jun 30, 2020 · 9f19862 · 9f19862
1 parent 8026ca9
commit 9f19862
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 81 deletions.
diff --git a/new-docs/puppeteer.jshandle._client.md b/new-docs/puppeteer.jshandle._client.md
diff --git a/new-docs/puppeteer.jshandle._constructor_.md b/new-docs/puppeteer.jshandle._constructor_.md
diff --git a/new-docs/puppeteer.jshandle._context.md b/new-docs/puppeteer.jshandle._context.md
diff --git a/new-docs/puppeteer.jshandle._disposed.md b/new-docs/puppeteer.jshandle._disposed.md
diff --git a/new-docs/puppeteer.jshandle._remoteobject.md b/new-docs/puppeteer.jshandle._remoteobject.md
diff --git a/new-docs/puppeteer.jshandle.md b/new-docs/puppeteer.jshandle.md
@@ -12,6 +12,10 @@ Represents an in-page JavaScript object. JSHandles can be created with the [page
 export declare class JSHandle 
 ```
 
+## Remarks
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `JSHandle` class.
+
 ## Example
 
 
@@ -23,21 +27,6 @@ JSHandle prevents the referenced JavaScript object from being garbage-collected
 
 JSHandle instances can be used as arguments for [Page.$eval()](./puppeteer.page._eval.md)<!-- -->, [Page.evaluate()](./puppeteer.page.evaluate.md)<!-- -->, and [Page.evaluateHandle()](./puppeteer.page.evaluatehandle.md)<!-- -->.
 
-## Constructors
-
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(context, client, remoteObject)](./puppeteer.jshandle._constructor_.md) |  | Constructs a new instance of the <code>JSHandle</code> class |
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [\_client](./puppeteer.jshandle._client.md) |  | [CDPSession](./puppeteer.cdpsession.md) |  |
-|  [\_context](./puppeteer.jshandle._context.md) |  | [ExecutionContext](./puppeteer.executioncontext.md) |  |
-|  [\_disposed](./puppeteer.jshandle._disposed.md) |  | boolean |  |
-|  [\_remoteObject](./puppeteer.jshandle._remoteobject.md) |  | Protocol.Runtime.RemoteObject |  |
-
 ## Methods
 
 |  Method | Modifiers | Description |

diff --git a/src/common/JSHandle.ts b/src/common/JSHandle.ts
@@ -100,11 +100,26 @@ export function createJSHandle(
  * @public
  */
 export class JSHandle {
+  /**
+   * @internal
+   */
   _context: ExecutionContext;
+  /**
+   * @internal
+   */
   _client: CDPSession;
+  /**
+   * @internal
+   */
   _remoteObject: Protocol.Runtime.RemoteObject;
+  /**
+   * @internal
+   */
   _disposed = false;
 
+  /**
+   * @internal
+   */
   constructor(
     context: ExecutionContext,
     client: CDPSession,