npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-fsm

v2.0.0

Published

Finite State Machine library

Downloads

99

Readme

fsm

Finite State Machine library Uses node-graph to work with state graph. Usage info and other docs will follow.

Meanwhile, you can look at test/test.js to see usage example.

Installation

npm install node-fsm

Usage

###new FSM(machineSpec, routerFunc)

machineSpec should contain state graph (nodes and edges like in node-graph). Additional properties are currentState that contains name of current machine state. data contains your arbitrary data tied with fsm.

routerFunc(edge, callback) is async function that checks, whether we made our transition successfully, or not. First argument is an edge object represents state graph edge we attempt to follow (hint: here you can process any arbitrary data you put on edge object in state graph). At the routerFunc completion you should call callback, passing err object, if you encountered any errors, and boolean variable that indicates whether we made transition or not. routerFunc is bound to fsm instance, so you can use this variable to access machine object.

var machineSpec = {
    nodes: [
        {
            name: 'A'
        },
        {
            name: 'B',
            youCanPutArbitraryDataOnYourNodes: { ... }
        }
    ],
    edges: [
        {
            name: 'A->B',
            from: 'A',
            to: 'B',
            youCanPutArbitraryDataOnYourEdgesToo: { ... }
        }
    ],
    currentState: 'A',
    data: { … }
}

var routerFunc = function (edge, callback) {
    // Make any external calls to determine,
    // whether our transition is succesfull or not
    // …
    callback(null, true);
}

var fsm = new FSM(machineSpec, routerFunc);

###availableEdges()

Returns array of edges, that can be followed from current machine state.

    var edges = fsm.availableEdges();
    
    // Returns:
    [
        {
            name: 'A->B',
            from: 'A',
            to: 'B',
            youCanPutArbitraryDataOnYourEdgesToo: { ... }
        }
    ]

###follow(edgeName, callback)

Attempt to change machine state following edge specified by edgeName. Callback should take two arguments (err, status), where err will contain any errors encountered during attempt to change state, and status will contain boolean value indication whether attempt was successful, or not.

Events

emit('state', edge)

When we successfully made a transition to a new state, fsm instance emits 'state' event, passing edge we followed as argument. While edge object contains both from and to fields, you can figure out, what was previous state.

emit('terminal', edge)

When we successfully made a transition to a new state, and this state is terminal (there is no edges outbound for current state) fsm instance emits 'terminal' event, passing edge we followed as argument.