Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

eventhandler

2.1.0 • Public • Published

eventhandler

Notes

Universal module defined to be used with requirejs, node, commonjs, or global scoped if no module loader is used.

All files in the dist folder are minified for production use. All files in the src directory are the source code for development use.

Development

Requirements

  • nodejs
  • npm install
  • npm install -g gulp

Test

gulp test

Gulp Commands

Each process is dependent upon the previous. If one fails the build process exits.

  • gulp
  • gulp test (Unit specifications)
  • gulp build (Test, folder clean-ups, minification, source maps, renaming)
  • gulp deploy (Test, build, versioning)

Usage

Installation

npm: npm install eventhandler
bower: bower install eventhandler

How to use...

var eventHandler1 = new EventHandler();
var eventHandler2 = new EventHandler();
var eventHandler3 = new EventHandler();
console.log('Subscribing EventHandler 2 to EventHandler 1.');
eventHandler2.subscribe(eventHandler1);
console.log('Subscribing EventHandler 3 to EventHandler 1.');
eventHandler3.subscribe(eventHandler1);

var data = {
    superhero: "Batman",
    sidekick: "Robin"
};

console.log('Adding a random event listener to EventHandler 1.');
eventHandler1.on('bang', function(data) {
    console.log('cb eventHandler: 1');
    console.log('this = ' + this);
    console.log(data.superhero + ' (POW!), ' + data.sidekick + ' (BOOM!)');
});

eventHandler2.on('bang', function(data) {
    console.log('cb eventHandler: 2');
    console.log('this = ' + this);
    console.log(data.superhero + ' (BAM!), ' + data.sidekick + ' (OUCH!)');
});

eventHandler3.on('bang', function(data) {
    console.log('cb eventHandler: 3');
    console.log('this = ' + this);
    console.log(data.superhero + ' (KABLOOM!), ' + data.sidekick + ' (KICK!)');
});

eventHandler1.emit('bang', data);

console.log('EventHandler 2 is unsubscribing from EventHandler 1.');
eventHandler2.unsubscribe(eventHandler1);

eventHandler1.emit('bang', data);

console.log('Removing all event listeners from EventHandler 1.');
eventHandler1.removeAllEventListeners('bang');

eventHandler1.emit('bang', data);

// Add some more subscribers for testing.
console.log('Subscribing EventHandler 2 to EventHandler 1.');
eventHandler2.subscribe(eventHandler1);
console.log('Removing all subscribers.');
eventHandler1.removeAllSubscribers();
eventHandler1.emit('bang', data);

// Add some more subscribers for testing.
console.log('Subscribing EventHandler 2 to EventHandler 1.');
eventHandler2.subscribe(eventHandler1);
console.log('Removing all subscriptions for EventHandler 2.');
eventHandler2.removeAllSubscriptions();
eventHandler1.emit('bang', data);

Release Notes

v2.1.0

Bug Fixes...

  • removeEventListener and unsubscribe now work properly. In turn this leads to removeAllSubscribers working.

Additional Changes...

  • Added removeAllSubscriptions which will remove all hooks from every other EventHandler that it's subscribed to.

v2.0.4

Additional Changes...

  • Enhanced performance of unsubscribe and removeEventListener even though they're rarely used but in some situations where something is adding and removing callbacks every process this is huge.

v2.0.0

Breaking Changings...

  • Changed the name of the eventhandler.js to EventHandler.js. Captial file names for classes just make more sense to me so I can distiguish bundles and frameworks from single classes.

New Features...

  • Added subscribe and unsubscribe. Each EventHandler can subscribe to one another. The event handler that subscribes to the other will emit the events in sync with the one subscribed to.

Additional...

  • Change the "main" property in package.json to point to the src/EventHandler.js since node is what uses it and needs the source code for debugging. If using things like Browserify it won't matter since the minification process happens after all files are compiled into one. This is better for everyone.

v1.0.8

Bug Fixes...

  • Fixed sourcemap linking for minified files. This is also fixed as part of the build process to automate proper sourcemap creation and linking.

install

npm i eventhandler

Downloadsweekly downloads

21

version

2.1.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar