package
Event emitter
npm install @socket.io/component-emitterGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Estimated unpacked size across 1 packages.
20.7 kB
Includes dependencies.
@socket.io/component-emitterEvent emitter component.
This project is a fork of the component-emitter project, with Socket.IO-specific TypeScript typings.
$ npm i @socket.io/component-emitterThe 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:
import { Emitter } from '@socket.io/component-emitter';
var emitter = new Emitter;
emitter.emit('something');As a mixin:
import { Emitter } from '@socket.io/component-emitter';
var user = { name: 'tobi' };
Emitter(user);
user.emit('im a user');As a prototype mixin:
import { Emitter } from '@socket.io/component-emitter';
Emitter(User.prototype);Register an event handler fn.
Register a single-shot event handler fn,
removed immediately after it is invoked the
first time.
event and fn to remove a listener.event to remove all listeners on that event.Emit an event with variable option args.
Return an array of callbacks, or an empty array.
Check if this emitter has event handlers.
MIT