Interface TestCoverage

interface TestCoverage {
    nesting: number;
    summary: {
        files: {
            branches: { count: number; line: number }[];
            coveredBranchCount: number;
            coveredBranchPercent: number;
            coveredFunctionCount: number;
            coveredFunctionPercent: number;
            coveredLineCount: number;
            coveredLinePercent: number;
            functions: { count: number; line: number; name: string }[];
            lines: { count: number; line: number }[];
            path: string;
            totalBranchCount: number;
            totalFunctionCount: number;
            totalLineCount: number;
        }[];
        thresholds: { branch: number; function: number; line: number };
        totals: {
            coveredBranchCount: number;
            coveredBranchPercent: number;
            coveredFunctionCount: number;
            coveredFunctionPercent: number;
            coveredLineCount: number;
            coveredLinePercent: number;
            totalBranchCount: number;
            totalFunctionCount: number;
            totalLineCount: number;
        };
        workingDirectory: string;
    };
}

Index

Properties

nesting summary

Properties

nesting

nesting: number

The nesting level of the test.

summary

summary: {
    files: {
        branches: { count: number; line: number }[];
        coveredBranchCount: number;
        coveredBranchPercent: number;
        coveredFunctionCount: number;
        coveredFunctionPercent: number;
        coveredLineCount: number;
        coveredLinePercent: number;
        functions: { count: number; line: number; name: string }[];
        lines: { count: number; line: number }[];
        path: string;
        totalBranchCount: number;
        totalFunctionCount: number;
        totalLineCount: number;
    }[];
    thresholds: { branch: number; function: number; line: number };
    totals: {
        coveredBranchCount: number;
        coveredBranchPercent: number;
        coveredFunctionCount: number;
        coveredFunctionPercent: number;
        coveredLineCount: number;
        coveredLinePercent: number;
        totalBranchCount: number;
        totalFunctionCount: number;
        totalLineCount: number;
    };
    workingDirectory: string;
}

An object containing the coverage report.

Type Declaration

files: {
    branches: { count: number; line: number }[];
    coveredBranchCount: number;
    coveredBranchPercent: number;
    coveredFunctionCount: number;
    coveredFunctionPercent: number;
    coveredLineCount: number;
    coveredLinePercent: number;
    functions: { count: number; line: number; name: string }[];
    lines: { count: number; line: number }[];
    path: string;
    totalBranchCount: number;
    totalFunctionCount: number;
    totalLineCount: number;
}[]
An array of coverage reports for individual files.
thresholds: { branch: number; function: number; line: number }
An object containing whether or not the coverage for each coverage type.

Since
v22.9.0
- branch: number
  The branch coverage threshold.
- function: number
  The function coverage threshold.
- line: number
  The line coverage threshold.
totals: {
    coveredBranchCount: number;
    coveredBranchPercent: number;
    coveredFunctionCount: number;
    coveredFunctionPercent: number;
    coveredLineCount: number;
    coveredLinePercent: number;
    totalBranchCount: number;
    totalFunctionCount: number;
    totalLineCount: number;
}
An object containing a summary of coverage for all files.
- coveredBranchCount: number
  The number of covered branches.
- coveredBranchPercent: number
  The percentage of branches covered.
- coveredFunctionCount: number
  The number of covered functions.
- coveredFunctionPercent: number
  The percentage of functions covered.
- coveredLineCount: number
  The number of covered lines.
- coveredLinePercent: number
  The percentage of lines covered.
- totalBranchCount: number
  The total number of branches.
- totalFunctionCount: number
  The total number of functions.
- totalLineCount: number
  The total number of lines.
workingDirectory: string
The working directory when code coverage began. This is useful for displaying relative path names in case the tests changed the working directory of the Node.js process.

Interface TestCoverage

Index

Properties

Properties

nesting

summary

Type Declaration

thresholds: { branch: number; function: number; line: number }

Since

branch: number

function: number

line: number

totals: {
    coveredBranchCount: number;
    coveredBranchPercent: number;
    coveredFunctionCount: number;
    coveredFunctionPercent: number;
    coveredLineCount: number;
    coveredLinePercent: number;
    totalBranchCount: number;
    totalFunctionCount: number;
    totalLineCount: number;
}

coveredBranchCount: number

coveredBranchPercent: number

coveredFunctionCount: number

coveredFunctionPercent: number

coveredLineCount: number

coveredLinePercent: number

totalBranchCount: number

totalFunctionCount: number

totalLineCount: number

workingDirectory: string

Settings

On This Page

Interface TestCoverage

Index

Properties

Properties

nesting

summary

Type Declaration

thresholds: { branch: number; function: number; line: number }

Since

branch: number

function: number

line: number

totals: { coveredBranchCount: number; coveredBranchPercent: number; coveredFunctionCount: number; coveredFunctionPercent: number; coveredLineCount: number; coveredLinePercent: number; totalBranchCount: number; totalFunctionCount: number; totalLineCount: number;}

coveredBranchCount: number

coveredBranchPercent: number

coveredFunctionCount: number

coveredFunctionPercent: number

coveredLineCount: number

coveredLinePercent: number

totalBranchCount: number

totalFunctionCount: number

totalLineCount: number

workingDirectory: string

Settings

On This Page

totals: {
coveredBranchCount: number;
coveredBranchPercent: number;
coveredFunctionCount: number;
coveredFunctionPercent: number;
coveredLineCount: number;
coveredLinePercent: number;
totalBranchCount: number;
totalFunctionCount: number;
totalLineCount: number;
}