Class Workflow<TInput, TSteps>

constructor

• new Workflow<
      TInput = unknown,
      TSteps extends Record<string, unknown> = Record<string, unknown>,
  >(
      name: string,
      options?: { revision?: string | number },
  ): Workflow<TInput, TSteps>

  Type Parameters

  • TInput = unknown
  • TSteps extends Record<string, unknown> = Record<string, unknown>

  Parameters

  • name: string
  • options: { revision?: string | number } = {}

  Returns Workflow<TInput, TSteps>

Readonlyname

Readonlynodes

Readonlyrevision

branch

• branch(condition: BranchCondition<TInput, TSteps>): this

  Add a branch point — call .path() after this to define paths

  Parameters

  • condition: BranchCondition<TInput, TSteps>

  Returns this

doUntil

• doUntil(
      condition: LoopCondition<TInput, TSteps>,
      builder: (w: Workflow<TInput, TSteps>) => Workflow<TInput, any>,
      options?: { maxIterations?: number },
  ): this

  Repeat steps until condition returns true (checked after each iteration)

  Parameters

  • condition: LoopCondition<TInput, TSteps>
  • builder: (w: Workflow<TInput, TSteps>) => Workflow<TInput, any>
  • Optionaloptions: { maxIterations?: number }

  Returns this

doWhile

• doWhile(
      condition: LoopCondition<TInput, TSteps>,
      builder: (w: Workflow<TInput, TSteps>) => Workflow<TInput, any>,
      options?: { maxIterations?: number },
  ): this

  Repeat steps while condition returns true (checked before each iteration)

  Parameters

  • condition: LoopCondition<TInput, TSteps>
  • builder: (w: Workflow<TInput, TSteps>) => Workflow<TInput, any>
  • Optionaloptions: { maxIterations?: number }

  Returns this

forEach

• forEach<TName extends string, TResult>(
      items: ForEachItemsExtractor<TInput, TSteps>,
      name: TName,
      handler: TypedStepHandler<TInput, TSteps, TResult>,
      options?: StepOptions<TInput, TSteps> & { maxIterations?: number },
  ): Workflow<TInput, TSteps & Record<TName, Awaited<TResult>>>

  Iterate over items, executing a step for each

  Type Parameters

  • TName extends string
  • TResult

  Parameters

  • items: ForEachItemsExtractor<TInput, TSteps>
  • name: TName
  • handler: TypedStepHandler<TInput, TSteps, TResult>
  • Optionaloptions: StepOptions<TInput, TSteps> & { maxIterations?: number }

  Returns Workflow<TInput, TSteps & Record<TName, Awaited<TResult>>>

getIndexedStepNames

• getIndexedStepNames(): string[]

  Step names that generate indexed per-iteration records (name:0, name:1, ...). Loop bodies and forEach steps both do; a plain step never does.

  Returns string[]

getStepNames

• getStepNames(): string[]

  Get flat list of step names for validation

  Returns string[]

map

• map<TName extends string, TResult>(
      name: TName,
      transform: (ctx: StepContext<TInput, TSteps>) => TResult,
  ): Workflow<TInput, TSteps & Record<TName, Awaited<TResult>>>

  Transform step results into a new value stored under the given name

  Type Parameters

  • TName extends string
  • TResult

  Parameters

  • name: TName
  • transform: (ctx: StepContext<TInput, TSteps>) => TResult

  Returns Workflow<TInput, TSteps & Record<TName, Awaited<TResult>>>

parallel

• parallel<TNewSteps extends Record<string, unknown>>(
      builder: (
          w: Workflow<TInput, TSteps>,
      ) => Workflow<TInput, TSteps & TNewSteps>,
  ): Workflow<TInput, TSteps & TNewSteps>

  Run multiple steps in parallel — accumulated types from sub-builder merge into TSteps

  Type Parameters

  • TNewSteps extends Record<string, unknown>

  Parameters

  • builder: (w: Workflow<TInput, TSteps>) => Workflow<TInput, TSteps & TNewSteps>

  Returns Workflow<TInput, TSteps & TNewSteps>

path

• path(
      name: string,
      builder: (w: Workflow<TInput, TSteps>) => Workflow<TInput, any>,
  ): this

  Define a branch path (must follow a .branch() call)

  Parameters

  • name: string
  • builder: (w: Workflow<TInput, TSteps>) => Workflow<TInput, any>

  Returns this

pivot

• pivot(): this

  Mark the point of no return.

  Everything before it stays compensatable; everything after is committed and is never rolled back, however the run ends. Past the pivot the only correct recovery is forward — retry, alert, fix — because there is no semantic inverse for "the welcome email was sent". Declare it explicitly; it is never inferred.

  Returns this

seal

• seal(): string

  Freeze this definition and return its durable structural identity.

  Returns string

step

• step<TName extends string, TResult>(
      name: TName,
      handler: TypedStepHandler<TInput, TSteps, TResult>,
      options?: StepOptions<TInput, TSteps & Record<TName, Awaited<TResult>>>,
  ): Workflow<TInput, TSteps & Record<TName, Awaited<TResult>>>

  Add a step to the workflow — return type accumulates into TSteps

  Type Parameters

  • TName extends string
  • TResult

  Parameters

  • name: TName
  • handler: TypedStepHandler<TInput, TSteps, TResult>
  • Optionaloptions: StepOptions<TInput, TSteps & Record<TName, Awaited<TResult>>>

  Returns Workflow<TInput, TSteps & Record<TName, Awaited<TResult>>>

subWorkflow

• subWorkflow<TName extends string>(
      name: TName,
      inputMapper: (ctx: StepContext<TInput, TSteps>) => unknown,
      options?: SubWorkflowOptions,
  ): Workflow<
      TInput,
      TSteps & Record<`sub:${TName}`, Record<string, unknown>>,
  >

  Call another registered workflow as a step

  Type Parameters

  • TName extends string

  Parameters

  • name: TName
  • inputMapper: (ctx: StepContext<TInput, TSteps>) => unknown
  • Optionaloptions: SubWorkflowOptions

  Returns Workflow<TInput, TSteps & Record<`sub:${TName}`, Record<string, unknown>>>

waitFor

• waitFor(event: string, options?: { timeout?: number }): this

  Wait for an external signal before continuing

  Parameters

  • event: string
  • Optionaloptions: { timeout?: number }

  Returns this