carbon-fsm
Travis CI
Carbon FSM is a lightweight but powerful finite state machine for JavaScript/nodejs
Installation
npm install carbon-fsm --save
Usage
const FiniteStateMachine = ;
Create an instance of Carbon-FSM and pass your finite state machine config as argument
var FSM = myAppConfig
Dispatch your application event to transition to next state as per the your application engine
await FSM
Display Current State of the FSM
FSM
Display your application data's state in the FSM
FSM
Display state transition history in the FSM
FSM
Display state transition diagram in the FSM
FSM
Display current of the FSM repeatedly
FSM
Application Engine Configuration
var myAppEngineConfiguration = // 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 function { console // do something with your data } // Event to State Transition Map EVENT_B: "STATE_B" EVENT_C: "STATE_C" ... EVENT_F: "STATE_F" EVENT_FINAL: "STATE_FINAL" EVENT_ERROR: "STATE_ERROR" STATE_ERROR: { /* 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 over type: "timer" timer_duration: 1000 timer_over: "$last_state" STATE_E: { /* */ } type: "timer" timer_duration: 1000 timer_over: "$initial_state" STATE_FINAL: { /* */ } // Special type of state marked with "final" type type: "final"
Examples
Check out data pipeline processing and a generic FSM app in the examples folder (https://github.com/HydroCarbons/carbon-fsm/tree/master/examples).
Contributing
You can contribute to this project with issues or pull requests.
Contact
If you have any ideas, feedback, requests or bug reports, you can reach me at hydrocarbons@outlook.com.