ConanFlow

The class ConanFlow contains the following methods:

on

this method allows connecting a Conan state with a React component, using a mapper function to describe the mapping

Input

statusName

Type: STATUS required

the STATUS we want to hook into

Returns

StatusDef<USER_STATUSES, STATUS>

The StatusDef object allows to add reactions, invoke transitions, steps and obtain the last ConanState Data

start

this method allows connecting a Conan state with a React component, using a mapper function to describe the mapping

Input

initialStatus

Type: StatusLike<USER_STATUSES> optional

optional initial STATUS to start the flow with

Returns

ConanFlow

this ConanFlow

toStateAll

this method creates a ConanState with the state of each status

Returns

ConanState<Status>

contains the states for all the statuses

toState

this method creates a ConanState with the state of the status passed as input

Input

status

Type: STATUS required

the STATUS we want to obtain the ConanState for

Returns

ConanState<USER_STATUSES[STATUS]>

ConanState for the status passed

Last updated