Angular Modernizer
    Preparing search index...

    Interface ScanArchitectureResult

    Result from the scan-architecture tool.

    interface ScanArchitectureResult {
        counts: ScanCounts;
        execution?: ScanExecution;
        intermediateResults?: Record<
            string,
            {
                filesProcessed?: number;
                message?: string;
                success: boolean;
                violations?: number;
            },
        >;
        metadata: {
            duration: number;
            projectRoot: string;
            rulesExecuted: string[];
        };
        operationId?: string;
        orchestration?: {
            autoSelectMode?: boolean;
            cacheHitRate: number;
            duration: number;
            filesAnalyzed: number;
            filesSkipped: number;
            incremental: boolean;
            parallel: boolean;
            resourceUsage?: { maxMemory?: number; maxWorkers?: number };
            throughput: number;
            useWorkerThreads?: boolean;
            workerStats?: {
                averageTaskDuration: number;
                completedTasks: number;
                totalCpuTime: number;
            };
        };
        pagination?: {
            hasMore: boolean;
            offset: number;
            returnedResults: number;
            totalResults: number;
        };
        pipeline?: string[];
        progress?: {
            current: number;
            eta: number;
            percentage: number;
            phase: string;
            total: number;
        };
        scope?: ResolvedScope;
        summary: string;
        violations: {
            category: string;
            column?: number;
            filePath: string;
            id: string;
            line?: number;
            message: string;
            metadata?: Record<string, unknown>;
            ruleId: string;
            severity: "info" | "error" | "warning";
            suggestedFix?: string;
        }[];
    }
    Index

    Properties

    counts execution? intermediateResults? metadata operationId? orchestration? pagination? pipeline? progress? scope? summary violations

    Properties

    counts: ScanCounts

    Counts over all violations, independent of the page.

    execution?: ScanExecution

    Run details: time budget, early stop, time per rule (slowest first).

    intermediateResults?: Record<
        string,
        {
            filesProcessed?: number;
            message?: string;
            success: boolean;
            violations?: number;
        },
    >

    Intermediate results from each pipeline stage (fluent API only).

    metadata: { duration: number; projectRoot: string; rulesExecuted: string[] }

    Analysis metadata.

    Type Declaration

    • duration: number

      Duration of the scan in milliseconds.

    • projectRoot: string

      Root path of the scanned project.

    • rulesExecuted: string[]

      Ids of the rules that ran.

    operationId?: string

    Operation ID for streaming mode (when streaming=true).

    orchestration?: {
        autoSelectMode?: boolean;
        cacheHitRate: number;
        duration: number;
        filesAnalyzed: number;
        filesSkipped: number;
        incremental: boolean;
        parallel: boolean;
        resourceUsage?: { maxMemory?: number; maxWorkers?: number };
        throughput: number;
        useWorkerThreads?: boolean;
        workerStats?: {
            averageTaskDuration: number;
            completedTasks: number;
            totalCpuTime: number;
        };
    }

    Orchestration metrics; set when orchestration.parallel or orchestration.incremental is set.

    Type Declaration

    • OptionalautoSelectMode?: boolean

      Value of orchestration.autoSelectMode.

    • cacheHitRate: number

      Cache hit rate of incremental analysis.

    • duration: number

      Duration of the scan in milliseconds.

    • filesAnalyzed: number

      Files analyzed.

    • filesSkipped: number

      Files skipped by incremental analysis.

    • incremental: boolean

      Value of orchestration.incremental.

    • parallel: boolean

      Value of orchestration.parallel.

    • OptionalresourceUsage?: { maxMemory?: number; maxWorkers?: number }

      Resource limits from orchestration.resourceLimits.

      • OptionalmaxMemory?: number

        Memory limit.

      • OptionalmaxWorkers?: number

        Maximum number of workers.

    • throughput: number

      Files per second.

    • OptionaluseWorkerThreads?: boolean

      Value of orchestration.useWorkerThreads.

    • OptionalworkerStats?: { averageTaskDuration: number; completedTasks: number; totalCpuTime: number }

      Parallel execution figures of the kernel.

      • averageTaskDuration: number

        Average task duration in milliseconds.

      • completedTasks: number

        Completed tasks.

      • totalCpuTime: number

        Summed CPU time of all tasks.

    pagination?: {
        hasMore: boolean;
        offset: number;
        returnedResults: number;
        totalResults: number;
    }

    Pagination metadata (when pagination is used).

    Type Declaration

    • hasMore: boolean

      Whether violations follow after this page.

    • offset: number

      Offset of the page (resultOffset).

    • returnedResults: number

      Number of violations in this page.

    • totalResults: number

      Number of all violations.

    pipeline?: string[]

    Pipeline stages executed (fluent API only). List of stages that were executed in the pipeline.

    progress?: {
        current: number;
        eta: number;
        percentage: number;
        phase: string;
        total: number;
    }

    Progress state (if enableProgress was true).

    Type Declaration

    • current: number

      Processed items.

    • eta: number

      Estimated remaining time; 0 when unknown.

    • percentage: number

      Progress in percent.

    • phase: string

      Progress event type of the kernel's progress reporter.

    • total: number

      Items in total.

    scope?: ResolvedScope

    Resolved scope information.

    summary: string

    Human-readable summary for LLM consumption.

    violations: {
        category: string;
        column?: number;
        filePath: string;
        id: string;
        line?: number;
        message: string;
        metadata?: Record<string, unknown>;
        ruleId: string;
        severity: "info" | "error" | "warning";
        suggestedFix?: string;
    }[]

    All violations found.

    Type Declaration

    • category: string

      Category of the rule.

    • Optionalcolumn?: number

      Column of the finding, when the rule reports one.

    • filePath: string

      File the violation was reported on.

    • id: string

      Violation id built from rule id, file, line and column.

    • Optionalline?: number

      1-based line of the finding, when the rule reports one.

    • message: string

      Rule message.

    • Optionalmetadata?: Record<string, unknown>

      Rule-specific details.

    • ruleId: string

      Rule that reported the violation, e.g. solid:circular-dependency.

    • severity: "info" | "error" | "warning"

      Severity reported by the rule, else the rule's default severity.

    • OptionalsuggestedFix?: string

      Fix suggested by the rule.

    Settings

    Member Visibility

    On This Page

    Properties