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

backbone-machina

v1.1.0

Published

machina.Fsm dressed as a fourth Backbone pillar next to Model, View and Router

Downloads

6

Readme

backbone-machina

machina.Fsm dressed as a fourth Backbone pillar next to Model, View and Router.

pipeline status latest version on npm code hosted on GitLab issue tracker on GitLab author: Julian Gonggrijp license text made with CoffeeScript changelog

Quickstart

$ npm i backbone-machina
import BackboneFsm from 'backbone-machina';

const someFsm = new BackboneFsm({...});
someFsm.on('enter:someState', (fsm, action) => {...});
someFsm.on('exit:anotherState', (fsm, action) => {...});

BackboneFsm is the default and only export of this package. It extends both machina.Fsm and Backbone.Events. In addition, it emits enter:stateName and exit:stateName events so you can hook into the behaviour of your FSM in the same way as you would do with Backbone.Model et al. This fully describes the API.

New in version 1.1.0: BackboneFsm is truly 100% compatible with both interfaces it extends. You can use '*' and 'all' interchangeably as wildcards when subscribing to events. machina.Fsm’s eventListeners option is supported as well. As a result, BackboneFsm can now be used in hierarchical settings as a drop-in replacement for machina.Fsm.

Why you should use this

If you are using Backbone, then you already have some powerful tools at your disposal for managing (changes of) state:

  • Model and Collection for the state of your data;
  • View for the state of your document;
  • Router for the state of the URL that is shown in the browser.

There is fourth type of state, however, that none of these classes captures very well. I would call this contextual state. Examples of contextual state include

  • whether the user has authenticated or not;
  • whether a search is blank, being edited, submitted, successful or unsuccessful;
  • whether there is still a connection with the backend.

Finite state machines are ideal for managing contextual state. There are many libraries out there that provide finite state machines, but I believe machina is the most declarative and also the most powerful of them all. To my knowledge, backbone-machina is the first library that marries Backbone and machina. Head to http://machina-js.org for some impressive examples of what a machina.Fsm can do!

Recommended usage

Head over to the wiki for some philosophy on Backbone project organization, which also discusses the place of BackboneFsm in your project.