@types/istanbul-lib-coverage

What is @types/istanbul-lib-coverage?

The @types/istanbul-lib-coverage package provides TypeScript type definitions for istanbul-lib-coverage, which is a library for JavaScript test coverage measurement and reporting. It allows developers to integrate coverage reporting into their TypeScript projects seamlessly, ensuring type safety and enhancing developer productivity.

What are @types/istanbul-lib-coverage's main functionalities?

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();

Other packages similar to @types/istanbul-lib-coverage

nyc

nyc is a command-line-interface tool that provides a wrapper around istanbul for test coverage. It is more comprehensive than @types/istanbul-lib-coverage as it includes the functionality to instrument code, run tests, and report coverage out of the box.

jest

Jest is a delightful JavaScript Testing Framework with a focus on simplicity. It includes built-in test coverage reporting that can be enabled with a simple configuration option. While Jest is a full testing framework, its coverage reporting is similar in functionality to what istanbul-lib-coverage provides but is integrated within the Jest ecosystem.

coveralls

Coveralls is a web service to help you track your code coverage over time, and ensure that all your new code is fully covered. It integrates with your CI environment to provide detailed coverage reports. Unlike @types/istanbul-lib-coverage, which is focused on providing type definitions, Coveralls offers a service for tracking and visualizing coverage data.

README

Installation

npm install --save @types/istanbul-lib-coverage

Summary

This package contains type definitions for istanbul-lib-coverage (https://istanbul.js.org).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/istanbul-lib-coverage.

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: none

Credits

These definitions were written by Jason Cheatham.