An universal JavaScript Emitter based on NodeJS EventEmitter.
npm install jvent> An universal JavaScript Emitter based on NodeJS EventEmitter.
$ npm install jvent
$ bower install jvent
html
`How-to
First, requires Jvent:
`js
var Jvent = require('jvent');
`Creates a new instance:
`js
var emitter = new Jvent();
`Now, defines a listener:
`js
function listener(arg1, arg2) {
alert(arg1 + ' '+ arg2);
})
`Then, adds a new event live with a listener:
`js
emitter.on('live', listener);
`Emitsthe event with some data:
`js
emitter.emit('live', 'param1', 'param2');
`API
$3
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.`js
emitter.on('live', listener);
`$3
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.`js
emitter.once('live', listener);
`$3
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.`js
emitter.off('live', listener);
`$3
Removes all listeners from the collection for a specified event.
- event - The name of the event you want to remove.`js
emitter.removeAllListeners('live');
`$3
Returns all listeners from the collection for a specified event.
- event - The name of the event.`js
emitter.listeners('live');
`$3
Execute each of the listeners collection in order with the given parameters.
All emitters emit the event newListener when new listeners are added.
- event - The name of the event you want to emit.`js
emitter.emit('live', 'data1', 'data2');
``
[npm-image]: https://img.shields.io/npm/v/jvent.svg
[lic-image]: https://img.shields.io/npm/l/jvent.svg
[npm-link]: https://npmjs.org/package/jvent
[travis-image]: https://img.shields.io/travis/pazguille/jvent.svg
[travis-link]: https://travis-ci.org/pazguille/jvent
[deps-image]: https://img.shields.io/david/pazguille/jvent.svg
[deps-link]: https://david-dm.org/pazguille/jvent
[devdeps-image]: https://img.shields.io/david/dev/pazguille/jvent.svg
[devdeps-link]: https://david-dm.org/pazguille/jvent#info=devDependencies
[dt-image]: https://img.shields.io/npm/dt/jvent.svg
[coverage-image]: https://img.shields.io/coveralls/pazguille/jvent.svg
[coverage-link]: https://coveralls.io/github/pazguille/jvent