AffectedFunction Type — typescript-sdk Architecture

Source Code

src/models/AffectedFunction.ts lines 21–58

export interface AffectedFunction {
    /**
     * File path relative to repository root.
     * @type {string}
     * @memberof AffectedFunction
     */
    file: string;
    /**
     * Name of the affected function.
     * @type {string}
     * @memberof AffectedFunction
     */
    name: string;
    /**
     * Line number of the function declaration.
     * @type {number}
     * @memberof AffectedFunction
     */
    line?: number;
    /**
     * Type of code element.
     * @type {string}
     * @memberof AffectedFunction
     */
    type: AffectedFunctionTypeEnum;
    /**
     * Number of hops from the target in the call graph.
     * @type {number}
     * @memberof AffectedFunction
     */
    distance: number;
    /**
     * Relationship type to the target.
     * @type {string}
     * @memberof AffectedFunction
     */
    relationship: AffectedFunctionRelationshipEnum;
}