Function Flow

Flow<
    const F extends unknown,
    V extends Record<string, FlowValueType>,
    const S extends { [key: string]: FlowStageConfig } = {},
>(
    config: FlowDefinition<V, S>,
    triggerInstance: F | undefined,
    body?: (params: FlowBodyParams<F, OutputsWithDotwalk<V>, S>) => void,
): FlowDefinition<V, S>
Interface
Creates a Flow record (sys_hub_flow) that defines a series of actions to execute when triggered.
Type Parameters
- const F extends unknown
- V extends Record<string, FlowValueType>
- const S extends { [key: string]: FlowStageConfig } = {}
Parameters
- config: FlowDefinition<V, S>
  Flow configuration — name, description, priority, variables, stages, and protectionPolicy settings.
- triggerInstance: F | undefined
  The trigger that starts this flow, created by calling wfa.trigger.
- Optionalbody: (params: FlowBodyParams<F, OutputsWithDotwalk<V>, S>) => void
  The flow body function. Receives params containing trigger, flowVariables, and stages (any flow-level stages declared in config).
Returns FlowDefinition<V, S>
- Defined in node_modules/.pnpm/@servicenow+sdk-core@4.7.0/node_modules/@servicenow/sdk-core/src/flow/Flow.ts:29