states

it feels good to reinvent the wheel

Finite state machine inspired by Emily and based on emitter.

Installation

Install with component:

$ component install bredele/states

Install with nodejs:

$ npm install component-states

Standalone:

<script src="states.js"></script>

API

Create a state machine with an initial state and add optional transitions :

var machine = states('open', transitions);

is the equivalent of:

states('open')
  .add(transitions);

the machine's state is available under machine.current

.add(state, event, cb, next)

Add transition (change from one state to an other triggered by an event) with callback:

machine.add('open','lock', function() {
  //do something
}, 'locked');

or without:

machine.add('open','lock','locked');

Add multiple transitions:

machine.add({
  'open' : [
    ['lock', fn, 'locked'],
    ['close', fn, 'closed']
  ],
  'locked': [
    ['close', 'closed'],
    ['break', 'open']
  ]
});

.emit(event, ...)

Emit an event and trigger a transition as following:

machine.emit('lock');
//state is now 'locked'

states inherits from emitter and can be used as a regular emitter.

Note

states is part of a collection of asynchronous patterns based on emitter:

• promise
• doors
• emitter-queue

License

The MIT License (MIT)

Copyright (c) 2014

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.