https://github.com/bredele/mood

:speak_no_evil: Give some mood to your code with a finite state machine
https://github.com/bredele/mood

finite-state-machine javascript state state-machine

Last synced: about 2 months ago
JSON representation

:speak_no_evil: Give some mood to your code with a finite state machine

• Host: GitHub
• URL: https://github.com/bredele/mood
• Owner: bredele
• Created: 2014-03-18T04:40:53.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2020-03-10T22:27:11.000Z (almost 5 years ago)
• Last Synced: 2024-10-30T01:34:35.902Z (2 months ago)
• Topics: finite-state-machine, javascript, state, state-machine
• Language: JavaScript
• Homepage:
• Size: 102 KB
• Stars: 76
• Watchers: 5
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        



  

  


  

  

  

  



# Mood

Mood is an elegant [state machine](https://en.wikipedia.org/wiki/Finite-state_machine#Concepts_and_terminology) 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

```js

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](/test/mood.js) for more information.

## Installation

```shell

npm install mood --save

```

[![NPM](https://nodei.co/npm/mood.png)](https://nodei.co/npm/mood/)

## 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.