Finite State Machines in javascript
Switch branches/tags
Nothing to show
Latest commit ec9d71c Jun 20, 2017 @dominictarr committed on GitHub Merge pull request #4 from StoneCypher/patch-1
mismatched backtick and single quote
Failed to load latest commit information.
test more tests Jun 3, 2014
.gitignore expanded and improved error handling. Jun 13, 2011
LICENSE license Sep 15, 2014 mismatched backtick and single quote Jun 20, 2017
index.js exports Jun 3, 2014
package.json 1.0.2 Sep 18, 2014
parse.js parse events Jun 3, 2014
wrap.js check in contract checker Sep 18, 2014


check properties of finite state machines.

There is a lot of academic research in this area, yet this module is very simple. There are a lot of fancy tools available, but they are not easy to use. If idea is really useful, then I think a very simple tool should be viable.




Define FSM as json, here is a stream with 4 states. This FSM expresses the constraint that the stream must not emit 'data' when paused, and also that it must not emit data after 'end'.

  START: {
    data   : 'START',
    pause  : 'PAUSED',
    end    : 'END',
    error  : 'ERROR'
    pause  : 'PAUSED',
    resume : 'START',
    error  : 'ERROR'
  ERROR: {},
  END: {}

we can check a number of properties of this machine. does this machine halt? (and in the right place?) can you reach every state from every other?


validate (fsm)

check that all transitions are to defined states.

reachable (fsm)

calculate all states can reach each other states. the result is in the form of

{STATE1: {STATE2: [event path from S1 to S2]}}

terminal (fsm)

return the list of states that cannot reach another state.

alias: deadlock

livelock (fsm, [terminal])

get list of states that cannot reach a terminal state.

combine(fsm1, fsm2, start1, start2)

combine two fsm into one, obeying all the transitions in each. TODO: throw an error if there are transitions that are impossible in the combined machine.