Angular Modernizer
    Preparing search index...

    Interface ValidateTransformationResult

    Validation result.

    interface ValidateTransformationResult {
        duration: number;
        incremental?: ValidateTransformationIncrementalMetadata;
        issues: {
            column?: number;
            details?: string;
            filePath?: string;
            line?: number;
            message: string;
            severity: "info" | "error" | "warning";
            type: "build" | "test" | "lint" | "syntax";
        }[];
        metadata: {
            buildCommand?: string;
            buildCommandSource?: string;
            buildValidation: boolean;
            cwd?: string;
            filePath: string;
            lintValidation: boolean;
            testValidation: boolean;
        };
        summary: string;
        valid: boolean;
    }
    Index

    Properties

    duration incremental? issues metadata summary valid

    Properties

    duration: number

    Validation duration in milliseconds.

    incremental?: ValidateTransformationIncrementalMetadata

    Incremental build metadata (if incremental mode was used)

    issues: {
        column?: number;
        details?: string;
        filePath?: string;
        line?: number;
        message: string;
        severity: "info" | "error" | "warning";
        type: "build" | "test" | "lint" | "syntax";
    }[]

    Validation issues found.

    Type Declaration

    • Optionalcolumn?: number

      Column of the issue.

    • Optionaldetails?: string

      Additional details of the issue.

    • OptionalfilePath?: string

      File the issue was found in.

    • Optionalline?: number

      Line of the issue (1-based).

    • message: string

      Issue description.

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

      Severity; only errors make the file not valid.

    • type: "build" | "test" | "lint" | "syntax"

      Check that reported the issue.

    metadata: {
        buildCommand?: string;
        buildCommandSource?: string;
        buildValidation: boolean;
        cwd?: string;
        filePath: string;
        lintValidation: boolean;
        testValidation: boolean;
    }

    Metadata about validation.

    Type Declaration

    • OptionalbuildCommand?: string

      Build command that ran (legacy validation).

    • OptionalbuildCommandSource?: string

      Where it came from: config, angular-cli, nx, vite, package-script or custom.

    • buildValidation: boolean

      Whether build validation was requested.

    • Optionalcwd?: string

      Project root the validation ran in.

    • filePath: string

      Validated file.

    • lintValidation: boolean

      Whether lint validation was requested.

    • testValidation: boolean

      Whether test validation was requested.

    summary: string

    Short text: verdict, checks, validation mode, issue counts and the first issues.

    valid: boolean

    Whether validation passed (no errors).

    Settings

    Member Visibility

    On This Page

    Properties