Documents / @faasjs/workflow / startWorkflow

Function: startWorkflow()

startWorkflow<TSteps, TRoot, TSchemas>(workflow, options?): Promise<StartWorkflowResult>

Create a workflow row and its root runnable step.

Type Parameters

TSteps

TSteps extends WorkflowSteps

TRoot

TRoot extends string

TSchemas

TSchemas extends WorkflowStepSchemas | undefined = undefined

Parameters

workflow

WorkflowDefinition<TSteps, TRoot, TSchemas>

Workflow definition.

options?

StartWorkflowOptions<WorkflowStepParams<TSchemas, TRoot>> = {}

Root step params.

Returns

Promise<StartWorkflowResult>

Example

import { startWorkflow } from '@faasjs/workflow'

import { orderWorkflow } from './workflows/order'

const { workflowId } = await startWorkflow(orderWorkflow, {
  params: {
    orderId: 'order_001',
  },
})

console.log(`Started workflow ${workflowId}`)