Interface WorkflowExecutionOptions

Options for WorkflowEngine.execute.

interface WorkflowExecutionOptions {
    dryRun?: boolean;
    onCheckpoint?: (checkpoint: WorkflowCheckpoint) => void;
    onProgress?: (state: WorkflowExecutionState) => void;
    onStepComplete?: (result: StepExecutionResult) => void;
    resumeFromCheckpoint?: string;
}

Index

Properties

dryRun? onCheckpoint? onProgress? onStepComplete? resumeFromCheckpoint?

Properties

`Optional`dryRun

dryRun?: boolean

Dry run mode: no tool is called, each step waits its estimatedDuration and completes with the result { dryRun: true }

`Optional`onCheckpoint

onCheckpoint?: (checkpoint: WorkflowCheckpoint) => void

Called after a checkpoint was created

`Optional`onProgress

onProgress?: (state: WorkflowExecutionState) => void

Called after each completed step

`Optional`onStepComplete

onStepComplete?: (result: StepExecutionResult) => void

Called with the result of each completed step

`Optional`resumeFromCheckpoint

resumeFromCheckpoint?: string

Resume from a checkpoint ID. Needs a CheckpointManager; without one the option is ignored.