# event-emitter

> Environment agnostic event emitter

Latest version **0.3.5** (published 2017-03-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install event-emitter
pnpm add event-emitter
yarn add event-emitter
bun add event-emitter
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.5 |
| Published | 2017-03-15 |
| First published | 2011-08-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/event-emitter) |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 244 |
| Author | Mariusz Nowak |
| Maintainers | medikoo |
| Keywords | event, events, trigger, observer, listener, emitter, pubsub |

## Links

- npm: https://www.npmjs.com/package/event-emitter
- Repository: https://github.com/medikoo/event-emitter
- Homepage: https://github.com/medikoo/event-emitter#readme
- Issues: https://github.com/medikoo/event-emitter/issues
- npm.io page: https://npm.io/package/event-emitter

## Dependencies (2)

- [d](https://npm.io/package/d.md) 1
- [es5-ext](https://npm.io/package/es5-ext.md) ~0.10.14

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 0.3.5 (latest) — 2017-03-15
- 0.3.4 — 2015-10-02
- 0.3.3 — 2015-01-30
- 0.3.2 — 2015-01-20
- 0.3.1 — 2014-04-25
- 0.3.0 — 2014-04-24
- 0.2.2 — 2013-06-05
- 0.2.1 — 2012-09-21
- 0.2.0 — 2012-09-19
- 0.1.5 — 2012-08-06
- 0.1.4 — 2012-06-13
- 0.1.3 — 2012-05-28
- 0.1.2 — 2012-01-22
- 0.1.1 — 2011-08-08
- 0.1.0 — 2011-08-08

## README

# event-emitter
## Environment agnostic event emitter

### Installation

	$ npm install event-emitter

To port it to Browser or any other (non CJS) environment, use your favorite CJS bundler. No favorite yet? Try: [Browserify](http://browserify.org/), [Webmake](https://github.com/medikoo/modules-webmake) or [Webpack](http://webpack.github.io/)

### Usage

```javascript
var ee = require('event-emitter');

var MyClass = function () { /* .. */ };
ee(MyClass.prototype); // All instances of MyClass will expose event-emitter interface

var emitter = new MyClass(), listener;

emitter.on('test', listener = function (args) {
  // … react to 'test' event
});

emitter.once('test', function (args) {
  // … react to first 'test' event (invoked only once!)
});

emitter.emit('test', arg1, arg2/*…args*/); // Two above listeners invoked
emitter.emit('test', arg1, arg2/*…args*/); // Only first listener invoked

emitter.off('test', listener);              // Removed first listener
emitter.emit('test', arg1, arg2/*…args*/); // No listeners invoked
```
### Additional utilities

#### allOff(obj) _(event-emitter/all-off)_

Removes all listeners from given event emitter object

#### hasListeners(obj[, name]) _(event-emitter/has-listeners)_

Whether object has some listeners attached to the object.
When `name` is provided, it checks listeners for specific event name

```javascript
var emitter = ee();
var hasListeners = require('event-emitter/has-listeners');
var listener = function () {};

hasListeners(emitter); // false

emitter.on('foo', listener);
hasListeners(emitter); // true
hasListeners(emitter, 'foo'); // true
hasListeners(emitter, 'bar'); // false

emitter.off('foo', listener);
hasListeners(emitter, 'foo'); // false
```

#### pipe(source, target[, emitMethodName]) _(event-emitter/pipe)_

Pipes all events from _source_ emitter onto _target_ emitter (all events from _source_ emitter will be emitted also on _target_ emitter, but not other way).  
Returns _pipe_ object which exposes `pipe.close` function. Invoke it to close configured _pipe_.  
It works internally by redefinition of `emit` method, if in your interface this method is referenced differently, provide its name (or symbol) with third argument.

#### unify(emitter1, emitter2) _(event-emitter/unify)_

Unifies event handling for two objects. Events emitted on _emitter1_ would be also emitted on _emitter2_, and other way back.  
Non reversible.

```javascript
var eeUnify = require('event-emitter/unify');

var emitter1 = ee(), listener1, listener3;
var emitter2 = ee(), listener2, listener4;

emitter1.on('test', listener1 = function () { });
emitter2.on('test', listener2 = function () { });

emitter1.emit('test'); // Invoked listener1
emitter2.emit('test'); // Invoked listener2

var unify = eeUnify(emitter1, emitter2);

emitter1.emit('test'); // Invoked listener1 and listener2
emitter2.emit('test'); // Invoked listener1 and listener2

emitter1.on('test', listener3 = function () { });
emitter2.on('test', listener4 = function () { });

emitter1.emit('test'); // Invoked listener1, listener2, listener3 and listener4
emitter2.emit('test'); // Invoked listener1, listener2, listener3 and listener4
```

### Tests [![Build Status](https://travis-ci.org/medikoo/event-emitter.png)](https://travis-ci.org/medikoo/event-emitter)

	$ npm test

---
_Source: https://npm.io/package/event-emitter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._