CircularDependencyCycle Type — typescript-sdk Architecture

Source Code

src/models/CircularDependencyCycle.ts lines 28–59

export interface CircularDependencyCycle {
    /**
     * Unique identifier for this cycle (e.g., cycle-1).
     * @type {string}
     * @memberof CircularDependencyCycle
     */
    id: string;
    /**
     * Files involved in this cycle, sorted alphabetically.
     * @type {Array<string>}
     * @memberof CircularDependencyCycle
     */
    files: Array<string>;
    /**
     * Import edges that form this cycle.
     * @type {Array<CycleEdge>}
     * @memberof CircularDependencyCycle
     */
    edges: Array<CycleEdge>;
    /**
     * Severity of this cycle based on cross-directory span and size.
     * @type {string}
     * @memberof CircularDependencyCycle
     */
    severity: CircularDependencyCycleSeverityEnum;
    /**
     * Suggested edge to break to resolve this cycle.
     * @type {string}
     * @memberof CircularDependencyCycle
     */
    breakingSuggestion?: string;
}