https://github.com/mango/emitter
A JavaScript event emitter written in ES6.
https://github.com/mango/emitter
Last synced: 8 months ago
JSON representation
A JavaScript event emitter written in ES6.
- Host: GitHub
- URL: https://github.com/mango/emitter
- Owner: Mango
- License: mit
- Created: 2015-03-17T22:11:57.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-05-04T18:17:02.000Z (about 11 years ago)
- Last Synced: 2025-07-17T23:41:02.190Z (11 months ago)
- Language: JavaScript
- Size: 254 KB
- Stars: 25
- Watchers: 9
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# emitter
> A JavaScript Emitter written in ES6.
## Usage
```js
import Emitter from 'emitter';
const bus = new Emitter();
bus.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.
```js
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.
```js
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.
```js
emitter.off('live', listener);
```
### Emitter#emit(event, [...args])
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.
```js
emitter.emit('live', 'data1', 'data2');
```
## npm-scripts
```
$ npm run compile
```
```
$ npm run browser
```
```
$ npm test
```
```
$ npm run hint
```
## License
MIT license. Copyright © 2015 [Mango](http://getmango.com).