@types/istanbul-lib-coverage

Creating a Coverage Map

This feature allows you to create a new coverage map, which is a collection of coverage results for various files. The coverage map can then be manipulated or queried to retrieve coverage information.

import { createCoverageMap } from 'istanbul-lib-coverage';
const coverageMap = createCoverageMap();

Adding File Coverage

This feature demonstrates how to add coverage data for a specific file to the coverage map. This is useful for incrementally building up coverage data as tests are run.

import { createCoverageMap } from 'istanbul-lib-coverage';
const coverageMap = createCoverageMap();
coverageMap.addFileCoverage({
  path: 'path/to/file.js',
  statementMap: {},
  fnMap: {},
  branchMap: {},
  s: {},
  f: {},
  b: {}
});

Generating Coverage Summary

This feature shows how to generate a summary of the coverage data contained within a coverage map. The summary provides an overview of coverage metrics such as lines covered, statements covered, etc.

import { createCoverageMap } from 'istanbul-lib-coverage';
const coverageMap = createCoverageMap();
// Assume coverageMap is populated
const summary = coverageMap.getCoverageSummary();