Travis CI

Carbon FSM is a lightweight but powerful finite state machine for JavaScript/nodejs

Installation

Usage

const{ FiniteStateMachine}=require("carbon-fsm");

Create an instance of Carbon-FSM and pass your finite state machine config as argument

varFSM=newFiniteStateMachine(myAppConfig)

Dispatch your application event to transition to next state as per the your application engine

awaitFSM.send("EVENT_NAME")

Display Current State of the FSM

FSM.currentState()

Display your application data's state in the FSM

FSM.Data()

Display state transition history in the FSM

FSM.displayHistory()e.g.[History]................................................................................0.00(fsm-init)=>[STATE_A]3.01EVENT_C @STATE_A=>[STATE_C]3.01EVENT_F @STATE_C=>[STATE_F]4.01timer_over @STATE_F=>[STATE_C]4.01EVENT_ERROR @STATE_C=>[STATE_ERROR]5.01timer_over @STATE_ERROR=>[STATE_C]5.01EVENT_A @STATE_C=>[STATE_A]14.23EVENT_FINAL @STATE_A=>[STATE_FINAL]................................................................................

Display state transition diagram in the FSM

FSM.displayStateTransitionDiagram()e.g.[StateTransitionDiagram]((fsm-init))=>STATE_A(EVENT_C)=>STATE_C(EVENT_F)=>STATE_F(timer_over)=>STATE_C(EVENT_ERROR)=>STATE_ERROR(timer_over)=>STATE_C(EVENT_A)=>STATE_A(EVENT_FINAL)=>STATE_FINAL

Display current of the FSM repeatedly

FSM.displayCurrentState(frequencyInMillseconds)

Application Engine Configuration

varmyAppEngineConfiguration={// App Specific Data_data:{},// Specify initial state of the FSM_initialState:"STATE_A",// State & Event Table// Format://   STATE_NAME : { STATE_DATA }//   where STATE_DATA = "on" is a function executed by FSM on entering the state//                    = type is type of the state. It can be "timer" or "final"//                    = TRANSITION_MAP = { EVENT_NAME : STATE_NAME }////   "timer" State (Special state type)//                    = FSM executes "on" function and then wait for "timer_duration"//                      before auto transitioning to state specified in "timer_over"//                    => timer_over can have a state name or//                             $last_state or $initial_state////  "final" State (Special state type)//                    = FSM stops processing events after executing "on" function//                      of final state.//STATE_A:{// State processing functionon:asyncfunction(data){console.log("Processing A")// do something with your data},// Event to State Transition MapEVENT_B:"STATE_B",EVENT_C:"STATE_C",          ...EVENT_F:"STATE_F",EVENT_FINAL:"STATE_FINAL",EVENT_ERROR:"STATE_ERROR"},STATE_ERROR:{on:asyncfunction(data){/* do something with the error scenario */},// Special type of state marked with "timer" type// special type of the state which will auto transition after timer is overtype:"timer",timer_duration:1000,timer_over:"$last_state"},STATE_E:{on:asyncfunction(data){/* */},type:"timer",timer_duration:1000,timer_over:"$initial_state"},STATE_FINAL:{on:asyncfunction(data){/* */},// Special type of state marked with "final" typetype:"final"}}

Examples

Contributing

Contact