Documents / @faasjs/workflow / DefineWorkflowOptions

Type Alias: DefineWorkflowOptions<TSteps, TRoot, TSchemas>

DefineWorkflowOptions<TSteps, TRoot, TSchemas> = Omit<DefineWorkflowOptionsInput, "root" | "steps" | "schemas"> & object & TSchemas extends WorkflowStepSchemas ? object : object

Options for defineWorkflow.

Type Declaration

root

root: TRoot

Root step name.

steps

steps: TSteps

Step handlers keyed by step name.

Type Parameters

TSteps

TSteps extends WorkflowSteps = WorkflowSteps

TRoot

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

TSchemas

TSchemas extends WorkflowStepSchemas | undefined = undefined