UntestedFunction Type — typescript-sdk Architecture

Source Code

src/models/UntestedFunction.ts lines 34–89

export interface UntestedFunction {
    /**
     * File path relative to repository root.
     * @type {string}
     * @memberof UntestedFunction
     */
    file: string;
    /**
     * Name of the function or method.
     * @type {string}
     * @memberof UntestedFunction
     */
    name: string;
    /**
     * Line number where the function is declared.
     * @type {number}
     * @memberof UntestedFunction
     */
    line: number;
    /**
     * Type of code element.
     * @type {string}
     * @memberof UntestedFunction
     */
    type: UntestedFunctionTypeEnum;
    /**
     * Confidence level of the untested classification.
     * @type {string}
     * @memberof UntestedFunction
     */
    confidence: UntestedFunctionConfidenceEnum;
    /**
     * Explanation of why this function is classified as untested.
     * @type {string}
     * @memberof UntestedFunction
     */
    reason: string;
    /**
     * 
     * @type {NearestTestedCaller}
     * @memberof UntestedFunction
     */
    nearestTestedCaller?: NearestTestedCaller;
    /**
     * The test file that covers the most sibling functions in the same production file. This is the recommended file in which to add a test for this untested function.
     * @type {string}
     * @memberof UntestedFunction
     */
    suggestedTestFile?: string;
    /**
     * Other functions in the same file that ARE tested, along with which test files cover them. Use this to see existing test patterns you can follow.
     * @type {Array<TestedSibling>}
     * @memberof UntestedFunction
     */
    testedSiblings?: Array<TestedSibling>;
}