Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pazguille/jvent
An universal JavaScript Emitter based on NodeJS EventEmitter.
https://github.com/pazguille/jvent
Last synced: 16 days ago
JSON representation
An universal JavaScript Emitter based on NodeJS EventEmitter.
- Host: GitHub
- URL: https://github.com/pazguille/jvent
- Owner: pazguille
- License: mit
- Created: 2012-05-25T19:38:51.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2020-05-23T12:05:06.000Z (over 4 years ago)
- Last Synced: 2024-10-26T11:29:20.168Z (17 days ago)
- Language: JavaScript
- Homepage:
- Size: 142 KB
- Stars: 46
- Watchers: 6
- Forks: 6
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
README
# jvent.js
> An universal JavaScript Emitter based on NodeJS EventEmitter.
[![NPM version][npm-image]][npm-link] [![License][lic-image]][npm-link] [![Build status][travis-image]][travis-link] [![Coverage Status][coverage-image]][coverage-link] [![Dependency status][deps-image]][deps-link] [![devDependency status][devdeps-image]][devdeps-link] [![downloads][dt-image]][npm-link]
## Installation
$ npm install jvent
$ bower install jvent
### Standalone
Also, you can use the standalone version without components.
```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
### Jvent#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.
```js
emitter.on('live', listener);
```
### Jvent#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.
```js
emitter.once('live', listener);
```
### Jvent#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.
```js
emitter.off('live', listener);
```
### Jvent#removeAllListeners(event)
Removes all `listeners` from the collection for a specified `event`.
- `event` - The name of the event you want to remove.
```js
emitter.removeAllListeners('live');
```
### Jvent#listeners(event)
Returns all `listeners` from the collection for a specified `event`.
- `event` - The name of the event.
```js
emitter.listeners('live');
```
### Jvent#emit(event, [arg1], [arg2], [...])
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');
```
## With :heart: by
- Guille Paz (Front-end developer | Web standards lover)
- E-mail: [[email protected]](mailto:[email protected])
- Twitter: [@pazguille](http://twitter.com/pazguille)
- Web: [http://pazguille.me](http://pazguille.me)
## License
MIT license. Copyright © 2016 [@pazguille](http://twitter.com/pazguille).
[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