Skip to content

Coverage ​

Added in: v1.11

Coverage gathers information about parts of JavaScript and CSS that were used by the page.

An example of using JavaScript coverage to produce Istanbul report for page load:

INFO

Coverage APIs are only supported on Chromium-based browsers.

js
const { chromium } = require('playwright');
const v8toIstanbul = require('v8-to-istanbul');

(async () => {
  const browser = await chromium.launch();
  const page = await browser.newPage();
  await page.coverage.startJSCoverage();
  await page.goto('https://chromium.org');
  const coverage = await page.coverage.stopJSCoverage();
  for (const entry of coverage) {
    const converter = v8toIstanbul('', 0, { source: entry.source });
    await converter.load();
    converter.applyCoverage(entry.functions);
    console.log(JSON.stringify(converter.toIstanbul()));
  }
  await browser.close();
})();

Methods ​

coverage.startCSSCoverage() ​

Added in: v1.11 async

Returns coverage is started

Arguments

  • options Object (optional)

    • resetOnNavigation boolean (optional)

      Whether to reset coverage on every navigation. Defaults to true.

coverage.startJSCoverage() ​

Added in: v1.11 async

Returns coverage is started

INFO

Anonymous scripts are ones that don't have an associated url. These are scripts that are dynamically created on the page using eval or new Function. If reportAnonymousScripts is set to true, anonymous scripts will have an empty string as their URL.

Arguments

  • options Object (optional)

    • reportAnonymousScripts boolean (optional)

      Whether anonymous scripts generated by the page should be reported. Defaults to false.

    • resetOnNavigation boolean (optional)

      Whether to reset coverage on every navigation. Defaults to true. Note that passing false does not guarantee that coverage persists through navigations, due to browser architecture limitations.

coverage.stopCSSCoverage() ​

Added in: v1.11 async

Returns the array of coverage reports for all stylesheets

INFO

CSS Coverage doesn't include dynamically injected style tags without sourceURLs.

Returns

  • Promise<Array<Object>>

coverage.stopJSCoverage() ​

Added in: v1.11 async

Returns the array of coverage reports for all scripts

INFO

JavaScript Coverage doesn't include anonymous scripts by default. However, scripts with sourceURLs are reported.

Returns

  • Promise<Array<Object>>

Released under the Apache 2.0 License.