Class WorkflowBuilder<RunInput, Steps>

Type Parameters

RunInput extends object = EmptyInput
Steps extends WorkflowSteps = EmptySteps

Index

Constructors

Methods

Constructors

constructor

new WorkflowBuilder<
    RunInput extends object = EmptyInput,
    Steps extends WorkflowSteps = EmptySteps,
>(
    state: {
        id: string;
        runAs: string;
        paused: boolean;
        activations: WorkflowActivation[];
        steps: WorkflowStep[];
    },
): WorkflowBuilder<RunInput, Steps>
Type Parameters
- RunInput extends object = EmptyInput
- Steps extends WorkflowSteps = EmptySteps
Parameters
- state: {
      id: string;
      runAs: string;
      paused: boolean;
      activations: WorkflowActivation[];
      steps: WorkflowStep[];
  }
Returns WorkflowBuilder<RunInput, Steps>

Methods

on

on<ActivationInput extends object>(
activation: ActivationConfig<ActivationInput>,
): WorkflowBuilder<MergeRunInput<RunInput, ActivationInput>, Steps>
Type Parameters
- ActivationInput extends object
Parameters
- activation: ActivationConfig<ActivationInput>
Returns WorkflowBuilder<MergeRunInput<RunInput, ActivationInput>, Steps>

step

step<const StepId extends string, Output = unknown>(
stepId: StepId,
config: StepConfig<RunInput, Steps>,
): WorkflowBuilder<RunInput, Steps & Record<StepId, Output>>
Type Parameters
- const StepId extends string
- Output = unknown
Parameters
- stepId: StepId
- config: StepConfig<RunInput, Steps>
Returns WorkflowBuilder<RunInput, Steps & Record<StepId, Output>>

toSpec

toSpec(): WorkflowDefinitionSpec
Returns WorkflowDefinitionSpec