mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
chore: generate docs for the protocol (#6213)
This commit is contained in:
22
new-docs/puppeteer.protocol.dom.describenoderequest.md
Normal file
22
new-docs/puppeteer.protocol.dom.describenoderequest.md
Normal file
@@ -0,0 +1,22 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [DOM](./puppeteer.protocol.dom.md) > [DescribeNodeRequest](./puppeteer.protocol.dom.describenoderequest.md)
|
||||
|
||||
## Protocol.DOM.DescribeNodeRequest interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface DescribeNodeRequest
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [backendNodeId](./puppeteer.protocol.dom.describenoderequest.backendnodeid.md) | [BackendNodeId](./puppeteer.protocol.dom.backendnodeid.md) | Identifier of the backend node. |
|
||||
| [depth](./puppeteer.protocol.dom.describenoderequest.depth.md) | [integer](./puppeteer.protocol.integer.md) | The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0. |
|
||||
| [nodeId](./puppeteer.protocol.dom.describenoderequest.nodeid.md) | [NodeId](./puppeteer.protocol.dom.nodeid.md) | Identifier of the node. |
|
||||
| [objectId](./puppeteer.protocol.dom.describenoderequest.objectid.md) | [Runtime.RemoteObjectId](./puppeteer.protocol.runtime.remoteobjectid.md) | JavaScript object id of the node wrapper. |
|
||||
| [pierce](./puppeteer.protocol.dom.describenoderequest.pierce.md) | boolean | Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false). |
|
||||
|
||||
Reference in New Issue
Block a user