Class StepList<StartInput>

Builds the ordered Step definitions for a Flow.

Type Parameters

StartInput
Input type of the optional starting Step.

Index

Properties

[startInputType]

Methods

[iterator] otherSteps empty startStep withoutStartStep

Properties

`Readonly`[startInputType]

"[startInputType]": (input: StartInput) => StartInput

Compile-time brand preserving the starting input type.

Methods

[iterator]

"[iterator]"(): Iterator<StepDefinition>
Iterates Step definitions in registration order.

Returns Iterator<StepDefinition>
An iterator over the registered Step definitions.

otherSteps

otherSteps(...steps: readonly Step<any>[]): StepList<StartInput>
Returns a copy with non-starting Steps appended.
Parameters
- ...steps: readonly Step<any>[]
  Registered Steps appended in argument order.
Returns StepList<StartInput>
A new StepList.

`Static`empty

empty<StartInput = void>(): StepList<StartInput>
Creates a StepList with no Steps.
Type Parameters
- StartInput = void
  Declared Flow start input type.
Returns StepList<StartInput>
An empty StepList.

`Static`startStep

startStep<StartInput>(step: Step<StartInput>): StepList<StartInput>
Creates a StepList with one starting Step.
Type Parameters
- StartInput
  Starting Step input type.
Parameters
- step: Step<StartInput>
  Step receiving startFlow input.
Returns StepList<StartInput>
A StepList with exactly one starting Step.

`Static`withoutStartStep

withoutStartStep<StartInput = never>(
...steps: readonly Step<any>[],
): StepList<StartInput>
Creates a StepList containing only non-starting Steps.
Type Parameters
- StartInput = never
  Declared start input; defaults to never.
Parameters
- ...steps: readonly Step<any>[]
  Steps reachable through decisions, RPCs, or failure routing.
Returns StepList<StartInput>
A StepList without a starting Step.