Package Exports

barracks

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 (barracks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Barracks

An event dispatcher for the flux architecture. Best used with browserify.

Installation

$ npm i --save barracks

Overview

/**
 * Initialize a dispatcher.
 */

var barracks = require('barracks');
var dispatcher = barracks({
  users: {
    add: function(usr) {console.log(usr + ' got added')},
    remove: function() {}
  },
  courses: {
    get: function() {},
    put: function() {}
  }
});

/**
 * Dispatch an event.
 */

dispatcher('users_add', 'Loki');
// => 'Loki got added'

API

dispatcher = barracks(actions)

Initialize a new barracks instance. The actions object should contain functions, namespaced at most one level deep. Returns a function.

// Initialize without namespaces.
var dispatcher = barracks({
  user: function() {},
  group: function() {}
});

// Initialize with namespaces.
var dispatcher = barracks({
  users: {
    add: function() {},
    remove: function() {}
  },
  courses: {
    get: function() {},
    put: function() {}
  }
});

dispatcher.waitFor(action)

Execute another function within the dispatcher before proceeding. Registered callbacks are always bound to the scope of the dispatcher, so you can just call this.waitFor to access the function from within a registered callback.

Calling users_initalize below will delegate execution to user_add and user_listen before proceeding to execute its own code.

var dispatcher = barracks({
  users: {
    initialize: function() {
      this.waitFor('user_add');
      this.waitFor('user_listen');
    },
    add: function() {
      // do async stuff
    },
    listen: function() {
      // start listening to socket server
    }
  }
});

dispatcher(action, data)

barracks() returns a dispatcher function which can be called to dispatch an action. By dispatching an action you call the corresponding function from the dispatcher and pass it the data. You can think of it as just calling a function.

In order to access namespaced functions you can delimit your string with underscores. So to access courses.get you'd dispatch the string courses_get.

Keep in mind that since you can only namespace 1 level deep, your dispatched actions should have no more than one underscore in them.

// Call a non-namespaced action.
dispatcher('group', [123, 'hello']);

// Call a namespaced action.
dispatcher('users_add', {foo: 'bar'});

barracks