Event Dispatcher
Alongside standard event emitting mechanism, this library provides
some additional utilities like event aggregator and generic event dispatching
repository.
This is an AMD library. To use it with Node.js and other CommonJS modules
based environments I recommend
jsloader/jsloader.
This library is partially modeled after
symfony/EventDispatcher.
Examples
Basic usage
Dispatching events
require([
"Bender/EventDispatcher/Event",
"Bender/EventDispatcher/EventDispatcher"
], function (Event, EventDispatcher) {
var eventDispatcher = new EventDispatcher();
eventDispatcher.getSupportedEvents = function () {
return ["a"];
};
eventDispatcher.addListener("a", function (evt) {
console.log("hello %s!", evt.data.place);
});
eventDispatcher.dispatch("a", new Event({ place: "world" }));
});
Aggregating event dispatchers
var auto = require("jsloader"),
eventAggregator,
eventDispatcherA,
eventDispatcherB,
Event = auto.load("Bender/EventDispatcher/Event"),
EventAggregator = auto.load("Bender/EventDispatcher/EventAggregator"),
EventDispatcher = auto.load("Bender/EventDispatcher/EventDispatcher");
eventAggregator = new EventAggregator();
eventDispatcherA.getSupportedEvents = function () {
return ["a"];
};
eventDispatcherB.getSupportedEvents = function () {
return ["b"];
};
eventAggregator.add(eventDispatcherA);
eventAggregator.add(eventDispatcherB);
eventAggregator.addListener("a", function (evt) {
console.log("hello %s!", evt.data.place);
});
eventAggregator.addListener("b", function (evt) {
console.log("hello %s!", evt.data.place);
});
eventDispatcherA.dispatch("a", new Event({ place: "world" }));
eventDispatcherB.dispatch("b", new Event({ place: "planet" }));
Advanced usage
Exposing single module entry point using two combined modules
var eventAggregator,
eventDispatcherAB = require("foo").eventDispatcherAB,
eventDispatcherC = require("bar").eventDispatcherC;
eventAggregator = new EventAggregator();
eventAggregator.add(eventDispatcherAB);
eventAggregator.add(eventDispatcherC);
module.exports = eventAggregator;
var a = require("a");
a.addListener("a", function () {});
a.addListener("b", function () {});
a.addListener("c", function () {});
Generic repository based on event dispatcher
define(["Bender/EventDispatcher/EventDispatcher/Repository"], function (Repository) {
var repository = new Repository();
repository.addListener(Repository.EVENT_ITEM_ADDED, function (evt) {
var item = evt.data.item,
repository = evt.data.repository;
console.log("added: " + item);
if (("world" === item) && 2148 !== (new Date().getFullYear())) {
repository.remove(item);
}
});
repository.addListener(Repository.EVENT_ITEM_REMOVED, function (evt) {
console.log("removed: " + evt.data.item);
});
repository.add("hello");
repository.add("world");
});
Semantic Versioning
This repository follows Semantic Versioning convention.