Angular Modernizer
    Preparing search index...

    Interface WorkflowDefinition

    A workflow: steps with dependencies plus execution settings. Input of WorkflowEngine.execute.

    interface WorkflowDefinition {
        config?: {
            autoCheckpoint?: boolean;
            autoRollback?: boolean;
            maxParallelSteps?: number;
            timeoutMs?: number;
        };
        description: string;
        id: string;
        metadata?: {
            createdBy?: string;
            migrationPlan?: unknown;
            source?: "plan-migration"
            | "manual"
            | "learn-patterns";
        };
        name: string;
        steps: WorkflowStep[];
        strategy?: WorkflowExecutionStrategy;
    }
    Index

    Properties

    config? description id metadata? name steps strategy?

    Properties

    config?: {
        autoCheckpoint?: boolean;
        autoRollback?: boolean;
        maxParallelSteps?: number;
        timeoutMs?: number;
    }

    Global configuration

    Type Declaration

    • OptionalautoCheckpoint?: boolean

      Whether to create a checkpoint after every fifth completed step

    • OptionalautoRollback?: boolean

      Whether to roll back to the last checkpoint when the workflow fails. The engine currently only logs the rollback; files are not restored.

    • OptionalmaxParallelSteps?: number

      Maximum parallel steps (for parallel strategy, default 3)

    • OptionaltimeoutMs?: number

      Timeout for the entire workflow in milliseconds (not enforced by the engine)

    description: string

    Workflow description

    id: string

    Unique workflow identifier

    metadata?: {
        createdBy?: string;
        migrationPlan?: unknown;
        source?: "plan-migration" | "manual" | "learn-patterns";
    }

    Descriptive metadata; not read by the engine

    Type Declaration

    • OptionalcreatedBy?: string

      Who or what created the workflow.

    • OptionalmigrationPlan?: unknown

      The migration plan the workflow was built from.

    • Optionalsource?: "plan-migration" | "manual" | "learn-patterns"

      Where the workflow came from.

    name: string

    Workflow name

    steps: WorkflowStep[]

    All steps in the workflow

    strategy?: WorkflowExecutionStrategy

    Execution strategy

    Settings

    Member Visibility

    On This Page

    Properties