All files / istanbul-lib-coverage/src index.ts

100% Statements 10/10
100% Branches 12/12
100% Functions 3/3
100% Lines 10/10

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79                                                                                  3x 1x   2x                 3x 1x   2x                 3x 1x   2x       2x            
import { CoverageMap } from "./coverage-map";
import type { CoverageMapData } from "./coverage-map";
import { CoverageSummary } from "./coverage-summary";
import type { CoverageSummaryData } from "./coverage-summary";
/*
 Copyright 2012-2015, Yahoo Inc.
 Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
 */
/**
 * @vitest/istanbul-lib-coverage exports an API that allows you to create and manipulate
 * file coverage, coverage maps (a set of file coverage objects) and summary
 * coverage objects. File coverage for the same file can be merged as can
 * entire coverage maps.
 *
 * @module Exports
 */
import { FileCoverage } from "./file-coverage";
import type { FileCoverageData } from "./file-coverage";
 
export type { CoverageMap } from "./coverage-map";
export type { CoverageMapData } from "./coverage-map";
export type { CoverageSummary } from "./coverage-summary";
export type { CoverageSummaryData, Totals } from "./coverage-summary";
export type { FileCoverage } from "./file-coverage";
export type {
  BranchMapping,
  Coverage,
  FileCoverageData,
  FunctionMapping,
  Location,
  Range,
} from "./file-coverage";
 
/**
 * creates a coverage summary object
 * @param obj an argument with the same semantics
 *  as the one passed to the `CoverageSummary` constructor
 */
export function createCoverageSummary(
  obj?: CoverageSummary | CoverageSummaryData,
): CoverageSummary {
  if (obj && obj instanceof CoverageSummary) {
    return obj;
  }
  return new CoverageSummary(obj);
}
 
/**
 * creates a CoverageMap object
 * @param obj optional - an argument with the same semantics
 *  as the one passed to the CoverageMap constructor.
 */
export function createCoverageMap(obj?: CoverageMap | CoverageMapData): CoverageMap {
  if (obj && obj instanceof CoverageMap) {
    return obj;
  }
  return new CoverageMap(obj);
}
 
/**
 * creates a FileCoverage object
 * @param obj optional - an argument with the same semantics
 *  as the one passed to the FileCoverage constructor.
 */
export function createFileCoverage(obj: string | FileCoverage | FileCoverageData): FileCoverage {
  if (obj && obj instanceof FileCoverage) {
    return obj;
  }
  return new FileCoverage(obj);
}
 
/** classes exported for reuse */
export const classes = {
  /**
   * the file coverage constructor
   */
  FileCoverage,
};