TestedFunction Type — typescript-sdk Architecture

Source Code

src/models/TestedFunction.ts lines 21–64

export interface TestedFunction {
    /**
     * File path relative to repository root.
     * @type {string}
     * @memberof TestedFunction
     */
    file: string;
    /**
     * Name of the function or method.
     * @type {string}
     * @memberof TestedFunction
     */
    name: string;
    /**
     * Line number where the function is declared.
     * @type {number}
     * @memberof TestedFunction
     */
    line: number;
    /**
     * Type of code element.
     * @type {string}
     * @memberof TestedFunction
     */
    type: TestedFunctionTypeEnum;
    /**
     * Test files that cover this function (directly or transitively).
     * @type {Array<string>}
     * @memberof TestedFunction
     */
    testFiles: Array<string>;
    /**
     * Number of test functions that directly call this function.
     * @type {number}
     * @memberof TestedFunction
     */
    directTestCallers: number;
    /**
     * Number of test functions that transitively reach this function.
     * @type {number}
     * @memberof TestedFunction
     */
    transitiveTestCallers: number;
}