puppeteer/website/versioned_docs/version-22.6.5/api/puppeteer.coverage.md
release-please[bot] e0932e5cce
chore: release main (#12274)
🤖 I have created a release *beep* *boop*
---


<details><summary>browsers: 2.2.2</summary>

##
[2.2.2](https://github.com/puppeteer/puppeteer/compare/browsers-v2.2.1...browsers-v2.2.2)
(2024-04-15)


### Bug Fixes

* remove NetworkServiceInProcess2 set by default
([#12261](https://github.com/puppeteer/puppeteer/issues/12261))
([ff4f70f](ff4f70f4ae)),
closes [#12257](https://github.com/puppeteer/puppeteer/issues/12257)
</details>

<details><summary>puppeteer: 22.6.5</summary>

##
[22.6.5](https://github.com/puppeteer/puppeteer/compare/puppeteer-v22.6.4...puppeteer-v22.6.5)
(2024-04-15)


### Miscellaneous Chores

* **puppeteer:** Synchronize puppeteer versions


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * puppeteer-core bumped from 22.6.4 to 22.6.5
    * @puppeteer/browsers bumped from 2.2.1 to 2.2.2
</details>

<details><summary>puppeteer-core: 22.6.5</summary>

##
[22.6.5](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v22.6.4...puppeteer-core-v22.6.5)
(2024-04-15)


### Bug Fixes

* remove NetworkServiceInProcess2 set by default
([#12261](https://github.com/puppeteer/puppeteer/issues/12261))
([ff4f70f](ff4f70f4ae)),
closes [#12257](https://github.com/puppeteer/puppeteer/issues/12257)
* use setImmediate to reduce flakiness when processing events
([#12264](https://github.com/puppeteer/puppeteer/issues/12264))
([73403b3](73403b323e))


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * @puppeteer/browsers bumped from 2.2.1 to 2.2.2
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2024-04-15 07:06:55 +00:00

130 lines
2.3 KiB
Markdown

---
sidebar_label: Coverage
---
# Coverage class
The Coverage class provides methods to gather information about parts of JavaScript and CSS that were used by the page.
#### Signature:
```typescript
export declare class Coverage
```
## Remarks
To output coverage in a form consumable by [Istanbul](https://github.com/istanbuljs), see [puppeteer-to-istanbul](https://github.com/istanbuljs/puppeteer-to-istanbul).
## Example
An example of using JavaScript and CSS coverage to get percentage of initially executed code:
```ts
// Enable both JavaScript and CSS coverage
await Promise.all([
page.coverage.startJSCoverage(),
page.coverage.startCSSCoverage(),
]);
// Navigate to page
await page.goto('https://example.com');
// Disable both JavaScript and CSS coverage
const [jsCoverage, cssCoverage] = await Promise.all([
page.coverage.stopJSCoverage(),
page.coverage.stopCSSCoverage(),
]);
let totalBytes = 0;
let usedBytes = 0;
const coverage = [...jsCoverage, ...cssCoverage];
for (const entry of coverage) {
totalBytes += entry.text.length;
for (const range of entry.ranges) usedBytes += range.end - range.start - 1;
}
console.log(`Bytes used: ${(usedBytes / totalBytes) * 100}%`);
```
## Constructors
<table><thead><tr><th>
Constructor
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
<span id="_constructor_">[(constructor)(client)](./puppeteer.coverage._constructor_.md)</span>
</td><td>
</td><td>
Constructs a new instance of the `Coverage` class
</td></tr>
</tbody></table>
## Methods
<table><thead><tr><th>
Method
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
<span id="startcsscoverage">[startCSSCoverage(options)](./puppeteer.coverage.startcsscoverage.md)</span>
</td><td>
</td><td>
</td></tr>
<tr><td>
<span id="startjscoverage">[startJSCoverage(options)](./puppeteer.coverage.startjscoverage.md)</span>
</td><td>
</td><td>
</td></tr>
<tr><td>
<span id="stopcsscoverage">[stopCSSCoverage()](./puppeteer.coverage.stopcsscoverage.md)</span>
</td><td>
</td><td>
Promise that resolves to the array of coverage reports for all stylesheets.
</td></tr>
<tr><td>
<span id="stopjscoverage">[stopJSCoverage()](./puppeteer.coverage.stopjscoverage.md)</span>
</td><td>
</td><td>
Promise that resolves to the array of coverage reports for all scripts.
</td></tr>
</tbody></table>