@socket.io/component-emitter

Event emitter component.

This project is a fork of the component-emitter project, with Socket.IO-specific TypeScript typings.

Installation

``
$ npm i @socket.io/component-emitter
`

API

$3

The Emitter may also be used as a mixin. For example
a "plain" object may become an emitter, or you may
extend an existing prototype.

As an Emitter instance:

`js
import { Emitter } from '@socket.io/component-emitter';

var emitter = new Emitter;
emitter.emit('something');
`

As a mixin:

`js
import { Emitter } from '@socket.io/component-emitter';

var user = { name: 'tobi' };
Emitter(user);

user.emit('im a user');
`

As a prototype mixin:

`js
import { Emitter } from '@socket.io/component-emitter';

Emitter(User.prototype);
`

$3

Register an event handler fn.

$3

Register a single-shot event handler fn,
removed immediately after it is invoked the
first time.

$3

* Pass event and fn to remove a listener.
* Pass event to remove all listeners on that event.
* Pass nothing to remove all listeners on all events.

$3

Emit an event with variable option args.

$3

Return an array of callbacks, or an empty array.

$3

Check if this emitter has event` handlers.

License

MIT