@types/istanbul-lib-report

What is @types/istanbul-lib-report?

The @types/istanbul-lib-report package provides TypeScript type definitions for istanbul-lib-report, which is a library for generating code coverage reports in various formats. It is part of the Istanbul code coverage tooling ecosystem. These type definitions enable TypeScript developers to use istanbul-lib-report in a type-safe manner, benefiting from compile-time type checks and IntelliSense in their IDE.

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

Creating a report context

This feature allows you to create a report context specifying the output directory and watermarks for coverage metrics. The context is used to generate reports.

import { createContext } from 'istanbul-lib-report';
const context = createContext({
  dir: './coverage',
  watermarks: {
    statements: [50, 80],
    functions: [50, 80],
    branches: [50, 80],
    lines: [50, 80]
  }
});

Generating a report

After creating a report context, you can generate a report in various formats (e.g., HTML, JSON) using the istanbul-reports package. This example demonstrates generating an HTML report.

import { create } from 'istanbul-reports';
const report = create('html', context);
report.execute(summarizer);

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

nyc

nyc is a command-line-interface and library for Istanbul, a JavaScript code coverage tool. It extends Istanbul's functionality by making it easier to use directly from the command line or as part of your testing workflow. Unlike @types/istanbul-lib-report, nyc does not focus on report generation alone but provides a more comprehensive coverage solution.

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. While it integrates with Istanbul for generating coverage reports, its primary focus is on tracking coverage statistics across multiple projects and branches, offering a broader scope compared to @types/istanbul-lib-report.

README

Installation

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

Summary

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

Details

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

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: @types/istanbul-lib-coverage

Credits

These definitions were written by Jason Cheatham, and Zacharias Björngren.