Interface CheckpointManager

Persists workflow checkpoints so a later run can resume from them.

interface CheckpointManager {
    listCheckpoints(workflowId: string): Promise<WorkflowCheckpoint[]>;
    loadCheckpoint(checkpointId: string): Promise<WorkflowCheckpoint | null>;
    saveCheckpoint(checkpoint: WorkflowCheckpoint): Promise<void>;
}

Index

Methods

listCheckpoints loadCheckpoint saveCheckpoint

Methods

listCheckpoints

listCheckpoints(workflowId: string): Promise<WorkflowCheckpoint[]>
List the checkpoints of a workflow; not called by the engine itself.
Parameters
- workflowId: string
Returns Promise<WorkflowCheckpoint[]>

loadCheckpoint

loadCheckpoint(checkpointId: string): Promise<WorkflowCheckpoint | null>
Load a checkpoint by ID; null when it does not exist. Called for WorkflowExecutionOptions.resumeFromCheckpoint.
Parameters
- checkpointId: string
Returns Promise<WorkflowCheckpoint | null>

saveCheckpoint

saveCheckpoint(checkpoint: WorkflowCheckpoint): Promise<void>
Store a checkpoint; called each time the engine creates one.
Parameters
- checkpoint: WorkflowCheckpoint
Returns Promise<void>