UserFlowDef

This interface allows defining a ConanFlow.

Property

Description

name

Type: string required

the name of the flow

statuses

Type: UserFlowStatusesDef<STATUSES, MUTATORS> required

The statuses definition this flow will have

initialStatus

Type: AsapLike<StatusLike<STATUSES>> optional

The initial status to start with

actions

Type: FlowActionsDef<STATUSES, MUTATORS, ACTIONS> optional

The actions this flow will execute

$onInit

Type: ReactionCb<STATUSES, any> [] optional

The array of reactions to execute when the ConanFlow is initialised

$onStop

Type: ReactionCb<STATUSES, any> [] optional

The array of reactions to execute when the ConanFlow is stopped

pipelineListener

Type: IConsumer<FlowEvent> optional

A listener can be attached to flow events

loggingRule

Type: Rule<FlowEvent> optional

the default logging policy can be overridden by passing a custom Rule

nature

Type: FlowEventNature optional

TBC: Alberto qué coño es esto