fsm-base

const StateMachine = require('fsm-base')

class Stateful extends StateMachine {
  constructor () {
    super([
      { from: undefined, to: 'one' },
      { from: 'one', to: 'two' },
      { from: 'two', to: 'three' },
      { from: [ 'one', 'three' ], to: 'four'}
    ])
  }
}
const instance = new Stateful()
instance.state = 'one'  // valid state change
instance.state = 'two'  // valid state change
instance.state = 'four' // throws - invalid state change

fsm-base

fsm-base
- StateMachine ⇐ Emitter ⏏
  - new StateMachine(initialState, validMoves)
  - .state : string
  - .setState(state)
  - .resetState()
  - "state" (state, prev)

StateMachine ⇐ `Emitter` ⏏

Kind: Exported class
Extends: Emitter

new StateMachine(initialState, validMoves)

Param	Type	Description
initialState	`string`	Initial state, e.g. 'pending'.
validMoves	`Array.<object>`	Array of valid move rules.

stateMachine.state : `string`

The current state

Kind: instance property of StateMachine
Throws:

INVALID_MOVE if an invalid move made

stateMachine.setState(state)

Set the current state. The second arg onward will be sent as event args.

Kind: instance method of StateMachine

Param	Type
state	`string`

stateMachine.resetState()

Reset to initial state.

Kind: instance method of StateMachine
Emits: event:"reset"

"state" (state, prev)

fired on every state change

Kind: event emitted by StateMachine

Param	Type	Description
state	`string`	the new state
prev	`string`	the previous state

Current Tags

0.7.0 ... latest (5 years ago)

fsm-base

fsm-base

StateMachine ⇐ Emitter ⏏

new StateMachine(initialState, validMoves)

stateMachine.state : string

stateMachine.setState(state)

stateMachine.resetState()

"state" (state, prev)

Current Tags

14 Versions

StateMachine ⇐ `Emitter` ⏏

stateMachine.state : `string`