mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
130 lines
2.2 KiB
Markdown
130 lines
2.2 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>
|
||
|
|
|
||
|
|
[(constructor)(client)](./puppeteer.coverage._constructor_.md)
|
||
|
|
|
||
|
|
</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>
|
||
|
|
|
||
|
|
[startCSSCoverage(options)](./puppeteer.coverage.startcsscoverage.md)
|
||
|
|
|
||
|
|
</td><td>
|
||
|
|
|
||
|
|
</td><td>
|
||
|
|
|
||
|
|
</td></tr>
|
||
|
|
<tr><td>
|
||
|
|
|
||
|
|
[startJSCoverage(options)](./puppeteer.coverage.startjscoverage.md)
|
||
|
|
|
||
|
|
</td><td>
|
||
|
|
|
||
|
|
</td><td>
|
||
|
|
|
||
|
|
</td></tr>
|
||
|
|
<tr><td>
|
||
|
|
|
||
|
|
[stopCSSCoverage()](./puppeteer.coverage.stopcsscoverage.md)
|
||
|
|
|
||
|
|
</td><td>
|
||
|
|
|
||
|
|
</td><td>
|
||
|
|
|
||
|
|
Promise that resolves to the array of coverage reports for all stylesheets.
|
||
|
|
|
||
|
|
</td></tr>
|
||
|
|
<tr><td>
|
||
|
|
|
||
|
|
[stopJSCoverage()](./puppeteer.coverage.stopjscoverage.md)
|
||
|
|
|
||
|
|
</td><td>
|
||
|
|
|
||
|
|
</td><td>
|
||
|
|
|
||
|
|
Promise that resolves to the array of coverage reports for all scripts.
|
||
|
|
|
||
|
|
</td></tr>
|
||
|
|
</tbody></table>
|