Documents / @faasjs/workflow / WorkflowDefinition

Type Alias: WorkflowDefinition<TSteps, TRoot, TSchemas>

WorkflowDefinition<TSteps, TRoot, TSchemas> = Readonly<{ root: TRoot; schemas?: TSchemas; steps: TSteps; type: string; }>

Workflow definition returned by defineWorkflow.

Type Parameters

TSteps

TSteps extends WorkflowSteps = WorkflowSteps

TRoot

TRoot extends Extract<keyof TSteps, string> = Extract<keyof TSteps, string>

TSchemas

TSchemas extends WorkflowStepSchemas | undefined = WorkflowStepSchemas | undefined