JSPM

  • Created
  • Published
  • Downloads 615
  • Score
    100M100P100Q99585F
  • License MIT

Tiny state machine

Package Exports

  • st8

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (st8) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

st8 Build Status

St8 is a tiny state machine for structural describing behavior of components.

Usage

$ npm install st8
var State = require('st8');

var state = new State({
    a: {
        enter: () => {
            ...
        },
        exit: () => {
            ...
        }
    },

    // shortcut for enter/exit
    b: [ () => {}, () => {} ],

    // enter shortcut, forwards to state d
    c: () => 'd',

    // shorter cut, redirects to state a
    d: 'a',

    // any other state
    _: 'a'
});


//enter state 'a', invoke corresponding callbacks
state.set('a');

//get current state
state.get(); // 'a'

API

let state = new State(states [, context])

Create a new state machine based on the states object. Optionally pass a context for callbacks.

state.get()

Get current state.

state.set(value)

Transition to a new state, invoking necessary callbacks.

NPM