puppeteer/new-docs/puppeteer.protocol.dom.getflatteneddocumentrequest.md

20 lines
997 B
Markdown
Raw Normal View History

<!-- 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; [DOM](./puppeteer.protocol.dom.md) &gt; [GetFlattenedDocumentRequest](./puppeteer.protocol.dom.getflatteneddocumentrequest.md)
## Protocol.DOM.GetFlattenedDocumentRequest interface
<b>Signature:</b>
```typescript
export interface GetFlattenedDocumentRequest
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [depth](./puppeteer.protocol.dom.getflatteneddocumentrequest.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. |
| [pierce](./puppeteer.protocol.dom.getflatteneddocumentrequest.pierce.md) | boolean | Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false). |