puppeteer/website/versioned_docs/version-17.1.3/api/puppeteer.coverage.md
release-please[bot] 9b120f6c7b
chore(main): release 17.1.3 (#8921)
* chore(main): release 17.1.3

* chore: generate versioned docs

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2022-09-08 13:16:39 +00:00

2.2 KiB

sidebar_label
Coverage

Coverage class

The Coverage class provides methods to gathers information about parts of JavaScript and CSS that were used by the page.

Signature:

export declare class Coverage

Remarks

To output coverage in a form consumable by Istanbul, see puppeteer-to-istanbul.

Example

An example of using JavaScript and CSS coverage to get percentage of initially executed code:

// 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

Constructor Modifiers Description
(constructor)(client) Constructs a new instance of the Coverage class

Methods

Method Modifiers Description
startCSSCoverage(options)
startJSCoverage(options)
stopCSSCoverage()
stopJSCoverage()