Angular Modernizer
    Preparing search index...

    Interface ScanAngularResult

    Result of the scan-angular tool.

    interface ScanAngularResult {
        counts: ScanCounts;
        execution?: CancelledExecution;
        metadata: {
            duration: number;
            projectRoot: string;
            rulesExecuted: string[];
        };
        orchestration?: {
            cacheHitRate: number;
            duration: number;
            filesAnalyzed: number;
            filesSkipped: number;
            incremental: boolean;
            parallel: boolean;
            throughput: number;
        };
        pagination?: {
            hasMore: boolean;
            offset: number;
            returnedResults: number;
            totalResults: number;
        };
        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? metadata orchestration? pagination? summary violations

    Properties

    counts: ScanCounts

    Counts over all violations, independent of the page.

    execution?: CancelledExecution

    Set when the client cancelled the scan; counts cover the analyzed files.

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

    Scan 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.

    orchestration?: {
        cacheHitRate: number;
        duration: number;
        filesAnalyzed: number;
        filesSkipped: number;
        incremental: boolean;
        parallel: boolean;
        throughput: number;
    }

    Orchestration figures; set only when orchestration.useWorkerThreads is set.

    Type Declaration

    • cacheHitRate: number

      Cache hit rate (always 0 here).

    • duration: number

      Duration of the scan in milliseconds.

    • filesAnalyzed: number

      Files selected for the scan.

    • filesSkipped: number

      Files skipped (always 0 here).

    • incremental: boolean

      Whether only changed files were analyzed (always false here).

    • parallel: boolean

      Whether the scan ran in parallel.

    • throughput: number

      Files per second.

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

    What the page covers of all violations.

    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.

    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;
    }[]

    The requested page of violations (maxResults, resultOffset).

    Type Declaration

    • category: string

      Rule category; Angular when the rule sets none.

    • Optionalcolumn?: number

      Column of the finding, when the rule reports one.

    • filePath: string

      File path relative to rootPath.

    • id: string

      Index-based id of the violation (angular-<index>).

    • 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.

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

      Severity reported by the rule.

    • OptionalsuggestedFix?: string

      Fix suggested by the rule; only with includeAutoFixes.

    Settings

    Member Visibility

    On This Page

    Properties