Emmy

Emmy is an EventEmitter which first tries to use target event system - DOM events, jQuery, Backbone, or other target EventEmitter interface, if implemented, ond only then uses own events.

It is best if you want to add events to non-eventable objects, like array, color, backbone-model or any other object. Also it is useful to implement a convenient wrapper for eventable objects, like webworkers, elements etc.

Emmy fully implements component-emitter interface, so you can safely replace existing emitter with Emmy and vice-versa.

What emmy is better than component-emitter? It may emit bubbling DOM events, as well as pass data to emitter. Besides, it uses safe WeakMaps instead of intrusive _callbacks property.

Use

Install:

$ npm install emmy

Use static API:

var Emitter = require('emmy');

Emitter.on(target, 'evt', function(){});
Emitter.emit(target, 'evt');
Emitter.off(target, 'evt');

Create Emitter instance:

var Emitter = require('emmy');

var emitter = new Emitter;
emitter.emit('something');

Mixin object:

var Emitter = requre('emmy');

user = {name: 'John'};

Emitter(user);

user.emit('hello');

Mixin prototype:

var Emitter = require('emmy');
Emitter(User.prototype);

Or inherit Emitter:

var Emitter = require('emmy');

function Actor(){};

//Give out emmy to an actor :)
Actor.prototype = Object.create(Emitter);

var actor = new Actor();

actor
//Bind events
.on('event', handler)
.on('otherEvent', handler)
.on('event2', [handler1, handler2]) //bind list of handlers


//Unbind events
.off('event', handler)
.off('otherEvent') //unbind all 'otherEvent' callbacks
.off('event2', [handler1, handler2]); //unbind list of handlers
.off(target) //unbind all events


//Emit events
.emit('a')
.emit('b', data, bubbles);

API

You also might be interested in more comprehensive emitter - give a glance at ENot — event notation system.

License

MIT