coveralls-api/build/jobs/from-lcov.d.ts

API client for coveralls.io

import { BaseJobArgs } from "./";
export declare type PostJobFromLCOVArgs = {
    /**
     * Path to lcov.info file
     */
    lcov_path: string;
} & BaseJobArgs;
/**
 * A hash representing a source code file and its coverage data for a single job.
 */
export declare type SourceFile = {
    /**
     * Represents the file path of this source file. Must be unique in the job. Can include slashes.
     * The file type for syntax highlighting will be determined from the file extension in this parameter.
     */
    name: string;
    /**
     * The MD5 digest of the full source code of this file.
     */
    source_digest: string;
    /**
     * The coverage data for this file for the file’s job.The item at index 0 represents the coverage for line 1 of the source code.
     * Acceptable values in the array:
     * - A positive integer if the line is covered, representing the number of times the line is hit during the test suite.
     * - 0 if the line is not covered by the test suite.
     * - null to indicate the line is not relevant to code coverage (it may be whitespace or a comment).
     */
    coverage: (number | null)[];
    /**
     * The branch data for this file for the file’s job. Each branch is represented by 4 elements in the array:
     * ```
     * [line-number, block-number, branch-number, hits, line-number-2, block-number-2, branch-number-2, hits-2,...]
     * ```
     * Acceptable values in the array:
     * Positive integers if the branch is covered, representing the number of times the branch is hit during the test suite.
     */
    branches?: number[];
    /**
     * The contents of the source file.
     */
    source?: string;
};
export declare function getSourceFiles(lcov_path: string): Promise<SourceFile[]>;