puppeteer/new-docs/puppeteer.protocol.tracing.startrequest.md
2020-07-13 14:01:35 +01:00

25 lines
1.8 KiB
Markdown

<!-- 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; [Tracing](./puppeteer.protocol.tracing.md) &gt; [StartRequest](./puppeteer.protocol.tracing.startrequest.md)
## Protocol.Tracing.StartRequest interface
<b>Signature:</b>
```typescript
export interface StartRequest
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [bufferUsageReportingInterval](./puppeteer.protocol.tracing.startrequest.bufferusagereportinginterval.md) | number | If set, the agent will issue bufferUsage events at this interval, specified in milliseconds |
| [categories](./puppeteer.protocol.tracing.startrequest.categories.md) | string | Category/tag filter |
| [options](./puppeteer.protocol.tracing.startrequest.options.md) | string | Tracing options |
| [streamCompression](./puppeteer.protocol.tracing.startrequest.streamcompression.md) | [StreamCompression](./puppeteer.protocol.tracing.streamcompression.md) | Compression format to use. This only applies when using <code>ReturnAsStream</code> transfer mode (defaults to <code>none</code>) |
| [streamFormat](./puppeteer.protocol.tracing.startrequest.streamformat.md) | [StreamFormat](./puppeteer.protocol.tracing.streamformat.md) | Trace data format to use. This only applies when using <code>ReturnAsStream</code> transfer mode (defaults to <code>json</code>). |
| [traceConfig](./puppeteer.protocol.tracing.startrequest.traceconfig.md) | [TraceConfig](./puppeteer.protocol.tracing.traceconfig.md) | |
| [transferMode](./puppeteer.protocol.tracing.startrequest.transfermode.md) | ('ReportEvents' \| 'ReturnAsStream') | Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to <code>ReportEvents</code>). |