chore: generate docs for the protocol

api-extractor.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
   "mainEntryPointFilePath": "<projectFolder>/lib/cjs/api-docs-entry.d.ts",
-  "bundledPackages": [ ],
+  "bundledPackages": [ "devtools-protocol" ],
 
   "apiReport": {
     "enabled": false

new-docs/puppeteer.browsercontext.overridepermissions.md

@@ -15,7 +15,7 @@ overridePermissions(origin: string, permissions: Protocol.Browser.PermissionType
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  origin | string | The origin to grant permissions to, e.g. "https://example.com". |
-|  permissions | Protocol.Browser.PermissionType\[\] | An array of permissions to grant. All permissions that are not listed here will be automatically denied. |
+|  permissions | [Protocol.Browser.PermissionType](./puppeteer.protocol.browser.permissiontype.md)<!-- -->\[\] | An array of permissions to grant. All permissions that are not listed here will be automatically denied. |
 
 <b>Returns:</b>
 

new-docs/puppeteer.dialog.type.md

@@ -11,7 +11,7 @@ type(): Protocol.Page.DialogType;
 ```
 <b>Returns:</b>
 
-Protocol.Page.DialogType
+[Protocol.Page.DialogType](./puppeteer.protocol.page.dialogtype.md)
 
 The type of the dialog.
 

new-docs/puppeteer.md

@@ -81,6 +81,12 @@
 |  [WaitForTargetOptions](./puppeteer.waitfortargetoptions.md) |  |
 |  [WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md) |  |
 
+## Namespaces
+
+|  Namespace | Description |
+|  --- | --- |
+|  [Protocol](./puppeteer.protocol.md) | \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* Auto-generated by protocol-dts-generator.ts, do not edit manually. \* \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* |
+
 ## Variables
 
 |  Variable | Description |

new-docs/puppeteer.page.cookies.md

@@ -20,5 +20,5 @@ cookies(...urls: string[]): Promise<Protocol.Network.Cookie[]>;
 
 <b>Returns:</b>
 
-Promise&lt;Protocol.Network.Cookie\[\]&gt;
+Promise&lt;[Protocol.Network.Cookie](./puppeteer.protocol.network.cookie.md)<!-- -->\[\]&gt;
 

new-docs/puppeteer.page.deletecookie.md

@@ -14,7 +14,7 @@ deleteCookie(...cookies: Protocol.Network.DeleteCookiesRequest[]): Promise<void>
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  cookies | Protocol.Network.DeleteCookiesRequest\[\] |  |
+|  cookies | [Protocol.Network.DeleteCookiesRequest](./puppeteer.protocol.network.deletecookiesrequest.md)<!-- -->\[\] |  |
 
 <b>Returns:</b>
 

new-docs/puppeteer.page.setcookie.md

@@ -14,7 +14,7 @@ setCookie(...cookies: Protocol.Network.CookieParam[]): Promise<void>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  cookies | Protocol.Network.CookieParam\[\] |  |
+|  cookies | [Protocol.Network.CookieParam](./puppeteer.protocol.network.cookieparam.md)<!-- -->\[\] |  |
 
 <b>Returns:</b>
 

new-docs/puppeteer.protocol.accessibility.axnode.backenddomnodeid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXNode](./puppeteer.protocol.accessibility.axnode.md) &gt; [backendDOMNodeId](./puppeteer.protocol.accessibility.axnode.backenddomnodeid.md)
+
+## Protocol.Accessibility.AXNode.backendDOMNodeId property
+
+The backend ID for the associated DOM node, if any.
+
+<b>Signature:</b>
+
+```typescript
+backendDOMNodeId?: DOM.BackendNodeId;
+```

new-docs/puppeteer.protocol.accessibility.axnode.childids.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXNode](./puppeteer.protocol.accessibility.axnode.md) &gt; [childIds](./puppeteer.protocol.accessibility.axnode.childids.md)
+
+## Protocol.Accessibility.AXNode.childIds property
+
+IDs for each of this node's child nodes.
+
+<b>Signature:</b>
+
+```typescript
+childIds?: AXNodeId[];
+```

new-docs/puppeteer.protocol.accessibility.axnode.description.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXNode](./puppeteer.protocol.accessibility.axnode.md) &gt; [description](./puppeteer.protocol.accessibility.axnode.description.md)
+
+## Protocol.Accessibility.AXNode.description property
+
+The accessible description for this `Node`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+description?: AXValue;
+```

new-docs/puppeteer.protocol.accessibility.axnode.ignored.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXNode](./puppeteer.protocol.accessibility.axnode.md) &gt; [ignored](./puppeteer.protocol.accessibility.axnode.ignored.md)
+
+## Protocol.Accessibility.AXNode.ignored property
+
+Whether this node is ignored for accessibility
+
+<b>Signature:</b>
+
+```typescript
+ignored: boolean;
+```

new-docs/puppeteer.protocol.accessibility.axnode.ignoredreasons.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXNode](./puppeteer.protocol.accessibility.axnode.md) &gt; [ignoredReasons](./puppeteer.protocol.accessibility.axnode.ignoredreasons.md)
+
+## Protocol.Accessibility.AXNode.ignoredReasons property
+
+Collection of reasons why this node is hidden.
+
+<b>Signature:</b>
+
+```typescript
+ignoredReasons?: AXProperty[];
+```

new-docs/puppeteer.protocol.accessibility.axnode.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXNode](./puppeteer.protocol.accessibility.axnode.md)
+
+## Protocol.Accessibility.AXNode interface
+
+A node in the accessibility tree.
+
+<b>Signature:</b>
+
+```typescript
+export interface AXNode 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [backendDOMNodeId](./puppeteer.protocol.accessibility.axnode.backenddomnodeid.md) | [DOM.BackendNodeId](./puppeteer.protocol.dom.backendnodeid.md) | The backend ID for the associated DOM node, if any. |
+|  [childIds](./puppeteer.protocol.accessibility.axnode.childids.md) | [AXNodeId](./puppeteer.protocol.accessibility.axnodeid.md)<!-- -->\[\] | IDs for each of this node's child nodes. |
+|  [description](./puppeteer.protocol.accessibility.axnode.description.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The accessible description for this <code>Node</code>. |
+|  [ignored](./puppeteer.protocol.accessibility.axnode.ignored.md) | boolean | Whether this node is ignored for accessibility |
+|  [ignoredReasons](./puppeteer.protocol.accessibility.axnode.ignoredreasons.md) | [AXProperty](./puppeteer.protocol.accessibility.axproperty.md)<!-- -->\[\] | Collection of reasons why this node is hidden. |
+|  [name](./puppeteer.protocol.accessibility.axnode.name.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The accessible name for this <code>Node</code>. |
+|  [nodeId](./puppeteer.protocol.accessibility.axnode.nodeid.md) | [AXNodeId](./puppeteer.protocol.accessibility.axnodeid.md) | Unique identifier for this node. |
+|  [properties](./puppeteer.protocol.accessibility.axnode.properties.md) | [AXProperty](./puppeteer.protocol.accessibility.axproperty.md)<!-- -->\[\] | All other properties |
+|  [role](./puppeteer.protocol.accessibility.axnode.role.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | This <code>Node</code>'s role, whether explicit or implicit. |
+|  [value](./puppeteer.protocol.accessibility.axnode.value.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The value for this <code>Node</code>. |
+

new-docs/puppeteer.protocol.accessibility.axnode.name.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXNode](./puppeteer.protocol.accessibility.axnode.md) &gt; [name](./puppeteer.protocol.accessibility.axnode.name.md)
+
+## Protocol.Accessibility.AXNode.name property
+
+The accessible name for this `Node`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+name?: AXValue;
+```

new-docs/puppeteer.protocol.accessibility.axnode.nodeid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXNode](./puppeteer.protocol.accessibility.axnode.md) &gt; [nodeId](./puppeteer.protocol.accessibility.axnode.nodeid.md)
+
+## Protocol.Accessibility.AXNode.nodeId property
+
+Unique identifier for this node.
+
+<b>Signature:</b>
+
+```typescript
+nodeId: AXNodeId;
+```

new-docs/puppeteer.protocol.accessibility.axnode.properties.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXNode](./puppeteer.protocol.accessibility.axnode.md) &gt; [properties](./puppeteer.protocol.accessibility.axnode.properties.md)
+
+## Protocol.Accessibility.AXNode.properties property
+
+All other properties
+
+<b>Signature:</b>
+
+```typescript
+properties?: AXProperty[];
+```

new-docs/puppeteer.protocol.accessibility.axnode.role.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXNode](./puppeteer.protocol.accessibility.axnode.md) &gt; [role](./puppeteer.protocol.accessibility.axnode.role.md)
+
+## Protocol.Accessibility.AXNode.role property
+
+This `Node`<!-- -->'s role, whether explicit or implicit.
+
+<b>Signature:</b>
+
+```typescript
+role?: AXValue;
+```

new-docs/puppeteer.protocol.accessibility.axnode.value.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXNode](./puppeteer.protocol.accessibility.axnode.md) &gt; [value](./puppeteer.protocol.accessibility.axnode.value.md)
+
+## Protocol.Accessibility.AXNode.value property
+
+The value for this `Node`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+value?: AXValue;
+```

new-docs/puppeteer.protocol.accessibility.axnodeid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXNodeId](./puppeteer.protocol.accessibility.axnodeid.md)
+
+## Protocol.Accessibility.AXNodeId type
+
+Unique accessibility node identifier.
+
+<b>Signature:</b>
+
+```typescript
+export type AXNodeId = string;
+```

new-docs/puppeteer.protocol.accessibility.axproperty.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXProperty](./puppeteer.protocol.accessibility.axproperty.md)
+
+## Protocol.Accessibility.AXProperty interface
+
+<b>Signature:</b>
+
+```typescript
+export interface AXProperty 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [name](./puppeteer.protocol.accessibility.axproperty.name.md) | [AXPropertyName](./puppeteer.protocol.accessibility.axpropertyname.md) | The name of this property. |
+|  [value](./puppeteer.protocol.accessibility.axproperty.value.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The value of this property. |
+

new-docs/puppeteer.protocol.accessibility.axproperty.name.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXProperty](./puppeteer.protocol.accessibility.axproperty.md) &gt; [name](./puppeteer.protocol.accessibility.axproperty.name.md)
+
+## Protocol.Accessibility.AXProperty.name property
+
+The name of this property.
+
+<b>Signature:</b>
+
+```typescript
+name: AXPropertyName;
+```

new-docs/puppeteer.protocol.accessibility.axproperty.value.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXProperty](./puppeteer.protocol.accessibility.axproperty.md) &gt; [value](./puppeteer.protocol.accessibility.axproperty.value.md)
+
+## Protocol.Accessibility.AXProperty.value property
+
+The value of this property.
+
+<b>Signature:</b>
+
+```typescript
+value: AXValue;
+```

new-docs/puppeteer.protocol.accessibility.axpropertyname.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXPropertyName](./puppeteer.protocol.accessibility.axpropertyname.md)
+
+## Protocol.Accessibility.AXPropertyName type
+
+Values of AXProperty name: - from 'busy' to 'roledescription': states which apply to every AX node - from 'live' to 'root': attributes which apply to nodes in live regions - from 'autocomplete' to 'valuetext': attributes which apply to widgets - from 'checked' to 'selected': states which apply to widgets - from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.
+
+<b>Signature:</b>
+
+```typescript
+export type AXPropertyName = ('busy' | 'disabled' | 'editable' | 'focusable' | 'focused' | 'hidden' | 'hiddenRoot' | 'invalid' | 'keyshortcuts' | 'settable' | 'roledescription' | 'live' | 'atomic' | 'relevant' | 'root' | 'autocomplete' | 'hasPopup' | 'level' | 'multiselectable' | 'orientation' | 'multiline' | 'readonly' | 'required' | 'valuemin' | 'valuemax' | 'valuetext' | 'checked' | 'expanded' | 'modal' | 'pressed' | 'selected' | 'activedescendant' | 'controls' | 'describedby' | 'details' | 'errormessage' | 'flowto' | 'labelledby' | 'owns');
+```

new-docs/puppeteer.protocol.accessibility.axrelatednode.backenddomnodeid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md) &gt; [backendDOMNodeId](./puppeteer.protocol.accessibility.axrelatednode.backenddomnodeid.md)
+
+## Protocol.Accessibility.AXRelatedNode.backendDOMNodeId property
+
+The BackendNodeId of the related DOM node.
+
+<b>Signature:</b>
+
+```typescript
+backendDOMNodeId: DOM.BackendNodeId;
+```

new-docs/puppeteer.protocol.accessibility.axrelatednode.idref.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md) &gt; [idref](./puppeteer.protocol.accessibility.axrelatednode.idref.md)
+
+## Protocol.Accessibility.AXRelatedNode.idref property
+
+The IDRef value provided, if any.
+
+<b>Signature:</b>
+
+```typescript
+idref?: string;
+```

new-docs/puppeteer.protocol.accessibility.axrelatednode.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md)
+
+## Protocol.Accessibility.AXRelatedNode interface
+
+<b>Signature:</b>
+
+```typescript
+export interface AXRelatedNode 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [backendDOMNodeId](./puppeteer.protocol.accessibility.axrelatednode.backenddomnodeid.md) | [DOM.BackendNodeId](./puppeteer.protocol.dom.backendnodeid.md) | The BackendNodeId of the related DOM node. |
+|  [idref](./puppeteer.protocol.accessibility.axrelatednode.idref.md) | string | The IDRef value provided, if any. |
+|  [text](./puppeteer.protocol.accessibility.axrelatednode.text.md) | string | The text alternative of this node in the current context. |
+

new-docs/puppeteer.protocol.accessibility.axrelatednode.text.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md) &gt; [text](./puppeteer.protocol.accessibility.axrelatednode.text.md)
+
+## Protocol.Accessibility.AXRelatedNode.text property
+
+The text alternative of this node in the current context.
+
+<b>Signature:</b>
+
+```typescript
+text?: string;
+```

new-docs/puppeteer.protocol.accessibility.axvalue.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Accessibility](./puppeteer.protocol.accessibility.md) &gt; [AXValue](./puppeteer.protocol.accessibility.axvalue.md)
+
+## Protocol.Accessibility.AXValue interface
+
+A single computed AX property.
+
+<b>Signature:</b>
+
+```typescript
+export interface AXValue 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [relatedNodes](./puppeteer.protocol.accessibility.axvalue.relatednodes.md) | [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md)<!-- -->\[\] | One or more related nodes, if applicable. |
+|  [sources](./puppeteer.protocol.accessibility.axvalue.sources.md) | [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md)<!-- -->\[\] | The sources which contributed to the computation of this property. |
+|  [type](./puppeteer.protocol.accessibility.axvalue.type.md) | [AXValueType](./puppeteer.protocol.accessibility.axvaluetype.md) | The type of this value. |
+|  [value](./puppeteer.protocol.accessibility.axvalue.value.md) | any | The computed value of this property. |
+