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

co-states

v0.1.0

Published

Coroutine based state machine.

Downloads

3

Readme

TOC

Co-states

Usage

A state machine can be initialized by passing a blueprint of possible states and the corresponding events for the states.

/* A simple traffic light as a state machine implementation. */
          blueprint = [
            {
              state: 'red',
              events: {
                go: 'green'
              }
            }, {
              state: 'yellow',
              events: {
                stop: 'red'
              }
            }, {
              state: 'green',
              events: {
                warn: 'yellow'
              }
            }
          ];
          trafficLights = new CoStates(blueprint);
          return assert(trafficLights instanceof CoStates);

New instances are automatically initialized with the first state in the blueprint.

var defaultState;
defaultState = blueprint[0].state;
return assert.equal(defaultState, trafficLights.getState());

Functions of the same name as the events in the blueprint are added to the instance.

/* Get event list from blueprint. */
          var eventList, events;
          events = [];
          eventList = _.pluck(blueprint, 'events');
          eventList.forEach(function(set) {
            return events = events.concat(Object.keys(set));
          });
          /* Check that functions are present. */
          return events.forEach(function(event) {
            return assert(_.isFunction(trafficLights[event]));
          });

These functions change the machine state according to the blueprint.

/*
            A 'state:change' event is triggered on the state
            machine when state is changed. The current state
            and the next state are passed as extra parameters.
           */
          trafficLights.on('state:change', function(current, next) {
            callback(assert.equal(next, 'green'));
            /* Reset machine. */
            return trafficLights = new CoStates(blueprint);
          });
          /* Trigger state change. */
          return trafficLights.go();

State can also be changed by triggering an event on the machine by the same name as the blueprint event.

trafficLights.on('state:change', function(current, next) {
  callback(assert.equal(next, 'green'));
  /* Reset machine. */
  return trafficLights = new CoStates(blueprint);
});
/* Trigger state change. */
return trafficLights.trigger('go');

State machine will throw an error if an invalid event is triggered.

/*
            An 'error' event is triggered when an invalid state
            event is attempted. An <Error> object is passed
            along with a helpful message.
           */
          trafficLights.on('error', function(e) {
            return callback(assert(e instanceof Error));
          });
          /* Trigger invalid event 'stop' for state 'red'. */
          return trafficLights.stop();

Co-states extends co-events so callbacks for events can be anything that co supports.

/* Generators FTW! */
          trafficLights.on('state:change', function*(__, next) {
            return yield function() {
              return callback(null);
            };
          });
          return trafficLights.go();