oklahoma
Minimal promise-based finite state manager
Last updated 4 years ago by andytjoslin .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install oklahoma 
SYNC missed versions from official npm registry.

oklahoma Build Status

Minimal promise-based finite state manager

Install

$ npm install --save oklahoma

Usage

var Oklahoma = require('oklahoma')

var fsm = Oklahoma({
  initial: 'alpha',
  states: {
    alpha: {
      targets: ['beta'],
      leave: [
        action1,
        action2
      ]
    },
    beta: {
      enter: [
        action3,
        action4
      ]
    }
  }
})

// Will change the state from 'alpha' to 'beta', running alpha's leave functions in order,
// then beta's enter functions in order.
// If any enter/leave function throws an error or rejects a promise, the state transition will abort.
fsm.go('beta')

API

Oklahoma(options) -> fsm

options
options.initial

Required Type: string

The id of the fsm's initial state.

options.states

Required Type: object

An object where the keys are the ids of available states, and the values are an object describing each state:

  • targets: Array<string> - An array of other states which can be transitioned to from this state.
  • enter: function|Array<function> - Function(s) that will be called in order when fsm.go is called to enter this state.
  • leave: function|Array<function> - Function(s) that will be called in order when fsm.go is called to leave this state.

Any enter or leave callback that returns a rejected promise will abort the current state transition.

fsm.current() -> string

Returns the id of the current state.

fsm.done() -> Prmise

Returns a promise that will resolve once the fsm is done changing states.

fsm.go(state, [...args]) -> Promise

Transition to the given state id. The id must be a valid target of the current state.

args will be passed into each enter/leave function.

Returns a promise that will be resolved or rejected when this state transition finishes.

If multiple state transitions are queued up at once, they will be run in order.

For example, fsm.go('bar'); fsm.go('baz'); will attempt to transition to bar, then once that completes (success or failure), will attempt a transition to baz.

License

MIT © Andrew Joslin

Current Tags

  • 2.2.0                                ...           latest (4 years ago)

9 Versions

  • 2.2.0                                ...           4 years ago
  • 2.1.0                                ...           4 years ago
  • 2.0.0                                ...           4 years ago
  • 1.0.5                                ...           4 years ago
  • 1.0.4                                ...           4 years ago
  • 1.0.3                                ...           4 years ago
  • 1.0.2                                ...           4 years ago
  • 1.0.1                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (4)
Dev Dependencies (3)
Dependents (1)

Copyright 2014 - 2017 © taobao.org |