The @types/istanbul-reports package provides TypeScript type definitions for the istanbul-reports package, which is used for generating code coverage reports in various formats as part of the Istanbul code coverage tooling. These type definitions enable TypeScript developers to work with istanbul-reports in a type-safe manner, ensuring that they use the API correctly according to the expected types.

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

Type definitions for creating coverage reports

This code demonstrates how to use the istanbul-api package along with type definitions from @types/istanbul-reports to create a reporter and generate coverage reports in JSON, LCOV, and text formats. The CoverageMap type is used to ensure the coverage data passed to the reporter.write method is correctly typed.

import { createReporter } from 'istanbul-api';
import { FileCoverage, CoverageMap } from 'istanbul-lib-coverage';

const reporter = createReporter();
reporter.addAll(['json', 'lcov', 'text']);
reporter.write(coverageMap);

Other packages similar to @types/istanbul-reports

Readme

Source

Installation

npm install --save @types/istanbul-reports

Summary

This package contains type definitions for istanbul-reports (https://github.com/istanbuljs/istanbuljs).

Details

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

index.d.ts

// Type definitions for istanbul-reports 3.0
// Project: https://github.com/istanbuljs/istanbuljs, https://istanbul.js.org
// Definitions by: Jason Cheatham <https://github.com/jason0x43>
//                 Elena Shcherbakova <https://github.com/not-a-doctor>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.4

import { Node, ReportBase } from 'istanbul-lib-report';

export function create<T extends keyof ReportOptions>(name: T, options?: Partial<ReportOptions[T]>): ReportBase;

export interface FileOptions {
    file: string;
}

export interface ProjectOptions {
    projectRoot: string;
}

export interface ReportOptions {
    clover: CloverOptions;
    cobertura: CoberturaOptions;
    'html-spa': HtmlSpaOptions;
    html: HtmlOptions;
    json: JsonOptions;
    'json-summary': JsonSummaryOptions;
    lcov: LcovOptions;
    lcovonly: LcovOnlyOptions;
    none: never;
    teamcity: TeamcityOptions;
    text: TextOptions;
    'text-lcov': TextLcovOptions;
    'text-summary': TextSummaryOptions;
}

export type ReportType = keyof ReportOptions;

export interface CloverOptions extends FileOptions, ProjectOptions {}

export interface CoberturaOptions extends FileOptions, ProjectOptions {}

export interface HtmlSpaOptions extends HtmlOptions {
    metricsToShow: Array<'lines' | 'branches' | 'functions' | 'statements'>;
}
export interface HtmlOptions {
    verbose: boolean;
    skipEmpty: boolean;
    subdir: string;
    linkMapper: LinkMapper;
}

export type JsonOptions = FileOptions;
export type JsonSummaryOptions = FileOptions;

export interface LcovOptions extends FileOptions, ProjectOptions {}
export interface LcovOnlyOptions extends FileOptions, ProjectOptions {}

export interface TeamcityOptions extends FileOptions {
    blockName: string;
}

export interface TextOptions extends FileOptions {
    maxCols: number;
    skipEmpty: boolean;
    skipFull: boolean;
}
export type TextLcovOptions = ProjectOptions;
export type TextSummaryOptions = FileOptions;

export interface LinkMapper {
    getPath(node: string | Node): string;
    relativePath(source: string | Node, target: string | Node): string;
    assetPath(node: Node, name: string): string;
}

Additional Details

Last updated: Tue, 01 Jun 2021 21:02:19 GMT
Dependencies: @types/istanbul-lib-report
Global values: none

Credits

These definitions were written by Jason Cheatham, and Elena Shcherbakova.

FAQs

What is @types/istanbul-reports?

Is @types/istanbul-reports popular?

Is @types/istanbul-reports well maintained?

Last updated on 01 Jun 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install