Skip to content

Latest commit

 

History

History
89 lines (66 loc) · 3.29 KB

Readme.md

File metadata and controls

89 lines (66 loc) · 3.29 KB
Raw

mood
npm travis dependencies Status

Mood

Mood is an elegant state machine you can use to model large number of problems, among which are UI state management, communication protocol design, language parsing, artificial intelligence and other engineering applications.

  • Finite state machine: Use mood to perform predetermined sequence of actions depending on a sequence of events with which they are presented.
  • Asynchronous: Mood plays well with your favorite libraries and use promises to transition from one state to an other.

Usage

import mood from 'mood'

// add transitions from constructor
const door = mood('init', {
  'open' :
    ['lock', () => {
      // do something when the current state is 'open'
      // and on the 'lock' event
    },'locked'],
  'locked': [
    ['close', 'closed'],
    ['break', () => {
      // do something when the current state is 'locked'
      // and on the 'break' event
    }, 'open']
  ]
})

// add new transition
// if transition returns promise, wait for promise to be resolved to trigger state change
door.add('closed', 'knock', function () {
  return new Promise(resolve => setTimeout(resolve, 1000))
}, 'open')

// trigger open-lock transition
door.trigger('lock')

// trigger locked-break transition
door.trigger('break').then(state => {
  // do something with new state
})

Check out our API for more information.

Installation

npm install mood --save

NPM

License

The MIT License (MIT)

Copyright (c) 2016 Olivier Wietrich

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.