README.md

jssm

A Javascript state machine with a simple API. Well tested, and typed with Flowtype. MIT license.

TL;DR

Specify finite state machines with a brief syntax. Run them. Derive charts from them. Save and load states. Make factories. Impress friends and loved ones. Cure corns and callouses.

const traffic_light = new jssm.machine({

  initial_state : 'Red',

  transitions   : [
    { action: 'Proceed', from:'Green',  to:'Yellow' },
    { action: 'Proceed', from:'Yellow', to:'Red'    },
    { action: 'Proceed', from:'Red',    to:'Green'  }
  ]

});

// use with actions
traffic_light.state();              // 'Red'
traffic_light.action('Proceed');    // true
traffic_light.state();              // 'Green'
traffic_light.action('Proceed');    // true
traffic_light.state();              // 'Yellow'
traffic_light.action('Proceed');    // true
traffic_light.state();              // 'Red'

// use with transitions
traffic_light.transition('Yellow'); // false (lights can't go from red to yellow, only to green)
traffic_light.state();              // 'Red'
traffic_light.transition('Red');    // false (lights can't go from red to red, either)
traffic_light.state();              // 'Red'
traffic_light.transition('Green');  // true
traffic_light.state();              // 'Green'

Which you can see being hand-executed in the console here:

Quick Start

Why

How To

Other state machines

There are a lot of state machine impls for JS, many quite a bit more mature than this one. Here are some options:

1. Finity 😮
2. Stately.js
3. machina.js
4. Pastafarian
5. Henderson
6. fsm-as-promised
7. state-machine
8. mood
9. FSM Workbench
10. SimpleStateMachine
11. shime/micro-machine
    1. soveran/micromachine (ruby)
12. fabiospampinato/FSM
13. HQarroum/FSM
14. Finite-State-Automata
15. finite-state-machine
16. nfm

And some similar stuff:

1. redux-machine
2. ember-fsm
3. State machine cat
4. Workty 😮
5. sam-simpler
6. event_chain
7. DRAKON
8. Yakindu Statechart Tools
9. GraphViz
   1. Viz.js, which we use