Awesome
emitter-es6
A JavaScript Emitter written in ES6.
Usage
import Emitter from 'Emitter';
let bus = new Emitter();
bus.emit('finish');
import Emitter from 'Emitter';
class Foo extends Emitter {
constructor() {
super.constructor();
}
...
};
let foo = new Foo();
foo.emit('finish');
API
Emitter#on(event, listener)
Adds a listener
to the collection for a specified event
.
event
- The name of the event you want to add.listener
- Listener you want to add from given event.
emitter.on('live', listener);
Emitter#once(event, listener)
Adds a one time listener
to the collection for a specified event
. It will execute only once.
event
- The name of the event.listener
- Listener you want to add from the given event.
emitter.once('live', listener);
Emitter#off(event, listener)
Removes a listener
from the collection for a specified event
.
event
- The name of the event.listener
- Listener you want to remove from the given event.
emitter.off('live', listener);
Emitter#removeAllListeners(event)
Removes all listeners
from the collection for a specified event
.
event
- The name of the event you want to remove.
emitter.removeAllListeners('live');
Emitter#listeners(event)
Returns all listeners
from the collection for a specified event
.
event
- The name of the event.
emitter.listeners('live');
Emitter#emit(event, [arg1], [arg2], [...])
Execute each of the listeners
collection in order with the given parameters.
event
- The name of the event you want to emit.[args, ...]
- The given arguments.
emitter.emit('live', 'data1', 'data2');
Build to ES5
npm run 6to5
Build to Browserify
npm run build
Tests
npm test
Made with ❤
- Guille Paz (Front-end developer | Web standards lover)
- E-mail: guille87paz@gmail.com
- Twitter: @pazguille
- Web: http://pazguille.me
License
MIT license. Copyright © 2015.