puppeteer/docs/api/puppeteer.jscoverageoptions.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer (#9150)
This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 09:07:05 +02:00

23 lines
2.2 KiB
Markdown

---
sidebar_label: JSCoverageOptions
---
# JSCoverageOptions interface
Set of configurable options for JS coverage.
#### Signature:
```typescript
export interface JSCoverageOptions
```
## Properties
| Property | Modifiers | Type | Description | Default |
| -------------------------------------------------------------------------------------- | --------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| [includeRawScriptCoverage?](./puppeteer.jscoverageoptions.includerawscriptcoverage.md) | | boolean | <i>(Optional)</i> Whether the result includes raw V8 script coverage entries. | |
| [reportAnonymousScripts?](./puppeteer.jscoverageoptions.reportanonymousscripts.md) | | boolean | <i>(Optional)</i> Whether anonymous scripts generated by the page should be reported. | |
| [resetOnNavigation?](./puppeteer.jscoverageoptions.resetonnavigation.md) | | boolean | <i>(Optional)</i> Whether to reset coverage on every navigation. | |
| [useBlockCoverage?](./puppeteer.jscoverageoptions.useblockcoverage.md) | | boolean | <i>(Optional)</i> Whether to collect coverage information at the block level. If true, coverage will be collected at the block level (this is the default). If false, coverage will be collected at the function level. | |