Class Workflow<TId, TInput, TOutput>

constructor

• new Workflow<TId, TInput, TOutput>(config): Workflow<TId, TInput, TOutput>

• Type Parameters

  • TId extends string = string
  • TInput = unknown
  • TOutput = unknown

  Parameters

  • config: WorkflowConfig<TId, TInput, TOutput>

  Returns Workflow<TId, TInput, TOutput>

Readonlyid

Optional Readonlydescription

Optional ReadonlyinputSchema

Optional ReadonlyoutputSchema

stepGraph

OptionalsnapshotStore

step

• step<TStepOutput>(step): this

• Type Parameters

  • TStepOutput

  Parameters

  • step: Step<string, unknown, TStepOutput, unknown, unknown>

  Returns this

withSnapshotStore

• withSnapshotStore(store): this

• Parameters

  • store: SnapshotStore

  Returns this

commit

• commit(): this

• Returns this

createRun

• createRun(runId?): Run<TInput, TOutput>

• Parameters

  • OptionalrunId: string

  Returns Run<TInput, TOutput>

resumeRun

• resumeRun(runId): Promise<Run<TInput, TOutput>>

• Parameters

  • runId: string

  Returns Promise<Run<TInput, TOutput>>

listRuns

• listRuns(): Promise<WorkflowSnapshot[]>

• Returns Promise<WorkflowSnapshot[]>