JSPM

@types/istanbul-reports

3.0.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 38003471
  • Score
    100M100P100Q248339F
  • License MIT

TypeScript definitions for istanbul-reports

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@types/istanbul-reports) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    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

    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

    Credits

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