Angular Modernizer
    Preparing search index...

    Interface TransformationResult

    Transformation result.

    interface TransformationResult {
        backup?: {
            backupPath?: string;
            created: boolean;
            gitSnapshot?: string;
            strategy: "git-stash" | "file-backup";
        };
        backupId?: string;
        buildValidation?: {
            buildCommand?: string;
            buildSystem?: string;
            duration?: number;
            errors?: string[];
            exitCode?: number;
            passed: boolean;
            success: boolean;
            timedOut?: boolean;
            warnings?: string[];
        };
        changes: { additions: number; deletions: number; linesChanged: number };
        filePath?: string;
        files?: { error?: string; path: string; success: boolean }[];
        intermediateResults?: {
            [stageName: string]: {
                filesProcessed?: number;
                message?: string;
                success: boolean;
                violations?: number;
            };
        };
        operationId?: string;
        orchestration?: {
            batchMode: boolean;
            duration: number;
            filesFailed: number;
            filesProcessed: number;
            filesSucceeded: number;
            parallel: boolean;
            throughput: number;
        };
        pipeline?: string[];
        preValidation?: {
            issues: {
                column?: number;
                filePath?: string;
                line?: number;
                message: string;
                severity: string;
                type: string;
            }[];
            valid: boolean;
        };
        progress?: {
            current: number;
            eta: number;
            percentage: number;
            phase: string;
            total: number;
        };
        rollback?: { performed: boolean; reason?: string; success?: boolean };
        rollbackReason?: string;
        rolledBack?: boolean;
        success: boolean;
        summary: string;
        transformation: string;
        validation: {
            introducedTypeErrors?: string[];
            syntaxValid: boolean;
            testsPass?: boolean;
            typeCheckPassed: boolean;
        };
        warnings?: string[];
    }
    Index

    Properties

    backup? backupId? buildValidation? changes filePath? files? intermediateResults? operationId? orchestration? pipeline? preValidation? progress? rollback? rollbackReason? rolledBack? success summary transformation validation warnings?

    Properties

    backup?: {
        backupPath?: string;
        created: boolean;
        gitSnapshot?: string;
        strategy: "git-stash" | "file-backup";
    }

    Backup information (if backup was created).

    Type Declaration

    • OptionalbackupPath?: string

      Path of the backup copy.

    • created: boolean

      true when a backup was written.

    • OptionalgitSnapshot?: string

      Git snapshot commit recorded with the backup (inside a git repository).

    • strategy: "git-stash" | "file-backup"

      Backup strategy.

    backupId?: string

    Backup ID for manual rollback if needed.

    buildValidation?: {
        buildCommand?: string;
        buildSystem?: string;
        duration?: number;
        errors?: string[];
        exitCode?: number;
        passed: boolean;
        success: boolean;
        timedOut?: boolean;
        warnings?: string[];
    }

    Build validation result (if buildCheck or validateBuild was enabled).

    Type Declaration

    • OptionalbuildCommand?: string

      Build command that ran.

    • OptionalbuildSystem?: string

      Detected build system.

    • Optionalduration?: number

      Build duration in milliseconds.

    • Optionalerrors?: string[]

      Build errors.

    • OptionalexitCode?: number

      Exit code of the build.

    • passed: boolean

      true when the build reported no error.

    • success: boolean

      Same as passed.

    • OptionaltimedOut?: boolean

      true when the build hit its timeout.

    • Optionalwarnings?: string[]

      Build warnings.

    changes: { additions: number; deletions: number; linesChanged: number }

    Summary of changes made.

    Type Declaration

    • additions: number

      Added lines.

    • deletions: number

      Removed lines.

    • linesChanged: number

      Changed lines.

    filePath?: string

    The transformed file path (single file mode).

    files?: { error?: string; path: string; success: boolean }[]

    Batch transformation results (batch mode).

    Type Declaration

    • Optionalerror?: string

      Error message of a failed file.

    • path: string

      File path.

    • success: boolean

      Whether the file was transformed.

    intermediateResults?: {
        [stageName: string]: {
            filesProcessed?: number;
            message?: string;
            success: boolean;
            violations?: number;
        };
    }

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

    operationId?: string

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

    orchestration?: {
        batchMode: boolean;
        duration: number;
        filesFailed: number;
        filesProcessed: number;
        filesSucceeded: number;
        parallel: boolean;
        throughput: number;
    }

    Orchestration metrics.

    Type Declaration

    • batchMode: boolean

      Batch mode (files) was used.

    • duration: number

      Duration in milliseconds.

    • filesFailed: number

      Files that failed.

    • filesProcessed: number

      Files processed.

    • filesSucceeded: number

      Files transformed successfully.

    • parallel: boolean

      Files were transformed in parallel.

    • throughput: number

      Files per second.

    pipeline?: string[]

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

    preValidation?: {
        issues: {
            column?: number;
            filePath?: string;
            line?: number;
            message: string;
            severity: string;
            type: string;
        }[];
        valid: boolean;
    }

    Pre-validation results (if performed).

    Type Declaration

    • issues: {
          column?: number;
          filePath?: string;
          line?: number;
          message: string;
          severity: string;
          type: string;
      }[]

      Issues found by the pre-transformation validator.

    • valid: boolean

      true when the file may be transformed.

    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 time to completion.

    • percentage: number

      Progress in percent.

    • phase: string

      Current step.

    • total: number

      Items in total.

    rollback?: { performed: boolean; reason?: string; success?: boolean }

    Rollback information (if rollback was performed).

    Type Declaration

    • performed: boolean

      true when the backup was restored.

    • Optionalreason?: string

      Why the rollback ran.

    • Optionalsuccess?: boolean

      true when the restore succeeded.

    rollbackReason?: string

    Rollback reason (if rolledBack is true).

    rolledBack?: boolean

    Whether the transformation was rolled back due to build failure.

    success: boolean

    Whether the transformation was successful.

    summary: string

    Short text: outcome, changes, checks, backup and rollback, first warnings.

    transformation: string

    Type of transformation applied.

    validation: {
        introducedTypeErrors?: string[];
        syntaxValid: boolean;
        testsPass?: boolean;
        typeCheckPassed: boolean;
    }

    Validation results.

    Type Declaration

    • OptionalintroducedTypeErrors?: string[]

      Type errors the transformation introduced into the file.

    • syntaxValid: boolean

      true when the transformation introduced no syntax error.

    • OptionaltestsPass?: boolean

      Test outcome, when tests ran.

    • typeCheckPassed: boolean

      true when the transformation introduced no type error.

    warnings?: string[]

    Any warnings or issues.

    Settings

    Member Visibility

    On This Page

    Properties