Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

istanbul-lib-coverage

istanbuljs106.2mBSD-3-Clause3.2.2TypeScript support: definitely-typed

Data library for istanbul coverage objects

istanbul, coverage, data

readme

istanbul-lib-coverage

Greenkeeper badge Build Status

An API that provides a read-only view of coverage information with the ability to merge and summarize coverage info.

Supersedes object-utils and collector from the v0 istanbul API.

See the docs for the full API.

var libCoverage = require('istanbul-lib-coverage');
var map = libCoverage.createCoverageMap(globalCoverageVar);
var summary = libCoverage.createCoverageSummary();

// merge another coverage map into the one we created
map.merge(otherCoverageMap);

// inspect and summarize all file coverage objects in the map
map.files().forEach(function(f) {
    var fc = map.fileCoverageFor(f),
        s = fc.toSummary();
    summary.merge(s);
});

console.log('Global summary', summary);

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.0.0 (2019-12-20)

Note: Version bump only for package istanbul-lib-coverage

3.0.0-alpha.2 (2019-12-07)

Note: Version bump only for package istanbul-lib-coverage

3.0.0-alpha.1 (2019-10-06)

Bug Fixes

3.0.0-alpha.0 (2019-06-19)

Features

  • Update dependencies, require Node.js 8 (#401) (bf3a539)

BREAKING CHANGES

  • Node.js 8 is now required

3.2.2 (2023-11-07)

Bug Fixes

3.2.1 (2023-11-04)

Bug Fixes

3.2.0 (2021-10-17)

Features

  • allow FileCoverage to be initialized with logical tracking (#644) (4cb5af1)

3.1.0 (2021-10-17)

Features

  • support tracking Logic Truthiness as additional metric in coverage API (#639) (0967c80)

3.0.2 (2021-10-11)

Bug Fixes

  • handle merging '0' indexed coverage with '1' indexed coverage (5dac2bc), closes #632

3.0.1 (2021-09-23)

Bug Fixes

  • merge branch/statement/functionMap's together when merging two coverage reports (#617) (ff1b5e9)

2.0.5 (2019-04-24)

Note: Version bump only for package istanbul-lib-coverage

2.0.4 (2019-03-12)

Note: Version bump only for package istanbul-lib-coverage

2.0.3 (2019-01-26)

Note: Version bump only for package istanbul-lib-coverage

2.0.2 (2018-12-25)

Note: Version bump only for package istanbul-lib-coverage

2.0.1 (2018-07-07)

Note: Version bump only for package istanbul-lib-coverage

2.0.0 (2018-06-06)

Bug Fixes

BREAKING CHANGES

  • a null prototype is now used in several places rather than the default {} assignment.

1.2.0 (2018-03-04)

Features

  • add skip-empty option for html & text reports (#140) (d2a4262)

1.1.2 (2018-02-13)

Note: Version bump only for package istanbul-lib-coverage

1.1.1 (2017-05-27)

1.1.0 (2017-04-29)

Bug Fixes

  • getBranchCoverageByLine() was looking for line coverage using wrong object structure (bf36658)

Features

  • add possibility to filter coverage maps when running reports post-hoc (#24) (e1c99d6)

1.0.2 (2017-03-27)

1.0.1 (2017-01-18)

Bug Fixes

  • handle edge-case surrounding merging two file coverage reports (22e154c)

1.0.0 (2016-08-12)

Bug Fixes

  • guard against missing statement (76aad99)