barracks

Barracks

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

Installation

npm i --save barracks

Overview

/**
 * Initialize barracks.
 */

var Dispatcher = require('barracks');
var dispatcher = Dispatcher();

/**
 * Register a new callback.
 */

dispatcher.register('eventName', function(arg) {
  return arg + ' got triggered';
});

/**
 * Dispatch registered callbacks for 'eventName'.
 */

dispatcher.dispatch('eventName', 'Loki');
// => 'Loki got triggered'

API

.register()

Register a new object to the store. Takes a {String} action that determines the message it should respond to, and a {Function} callback that executes the response.

dispatcher.register('eventName', function(arg) {
  return arg;
});

dispatcher.register('otherEvent', function() {
  return 'hi';
)});

.dispatch()

Trigger all callbacks corresponding to {String} action and provide them an argument of {Mixed} data.

dispatcher.dispatch('eventName', 12);
// => 12

dispatcher.dispatch('otherEvent');
// => throw Error

dispatcher.dispatch('otherEvent', null);
// => 'hi'

License

MIT © Yoshua Wuyts