pax_global_header00006660000000000000000000000064142271023040014505gustar00rootroot0000000000000052 comment=ab6a6d4db8302afc2c70ee38d72e4e292bbef3d4 emitter-3.1.0/000077500000000000000000000000001422710230400131575ustar00rootroot00000000000000emitter-3.1.0/.gitignore000066400000000000000000000000151422710230400151430ustar00rootroot00000000000000node_modules emitter-3.1.0/.travis.yml000066400000000000000000000000651422710230400152710ustar00rootroot00000000000000language: node_js node_js: - "6.14" - "7.10" - "8.12"emitter-3.1.0/History.md000066400000000000000000000042251422710230400151450ustar00rootroot00000000000000# [3.1.0](https://github.com/socketio/emitter/compare/3.0.0...3.1.0) (2022-04-17) ### Features * add ESM version ([54468cf](https://github.com/socketio/emitter/commit/54468cf7a3753f4fde435b70f5df57974588ed68)) # [3.0.0](https://github.com/socketio/emitter/compare/2.0.0...3.0.0) (2021-10-14) ### Features * add support for typed events ([84397cb](https://github.com/socketio/emitter/commit/84397cb0cd6265e0ee79adbf1607beff12ca9f16)) ### BREAKING CHANGES * we now use a named export instead of a default export ```js // before import Emitter from "@socket.io/component-emitter" // after import { Emitter } from "@socket.io/component-emitter" ``` [1]: https://github.com/socketio/socket.io-client/blob/a9e5b85580e8edca0b0fd2850c3741d3d86a96e2/lib/typed-events.ts 1.3.0 / 2018-04-15 ================== * removed bower support * expose emitter on `exports` * prevent de-optimization from using `arguments` 1.2.1 / 2016-04-18 ================== * enable client side use 1.2.0 / 2014-02-12 ================== * prefix events with `$` to support object prototype method names 1.1.3 / 2014-06-20 ================== * republish for npm * add LICENSE file 1.1.2 / 2014-02-10 ================== * package: rename to "component-emitter" * package: update "main" and "component" fields * Add license to Readme (same format as the other components) * created .npmignore * travis stuff 1.1.1 / 2013-12-01 ================== * fix .once adding .on to the listener * docs: Emitter#off() * component: add `.repo` prop 1.1.0 / 2013-10-20 ================== * add `.addEventListener()` and `.removeEventListener()` aliases 1.0.1 / 2013-06-27 ================== * add support for legacy ie 1.0.0 / 2013-02-26 ================== * add `.off()` support for removing all listeners 0.0.6 / 2012-10-08 ================== * add `this._callbacks` initialization to prevent funky gotcha 0.0.5 / 2012-09-07 ================== * fix `Emitter.call(this)` usage 0.0.3 / 2012-07-11 ================== * add `.listeners()` * rename `.has()` to `.hasListeners()` 0.0.2 / 2012-06-28 ================== * fix `.off()` with `.once()`-registered callbacks emitter-3.1.0/LICENSE000066400000000000000000000021201422710230400141570ustar00rootroot00000000000000(The MIT License) Copyright (c) 2014 Component contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. emitter-3.1.0/Makefile000066400000000000000000000001311422710230400146120ustar00rootroot00000000000000 test: @./node_modules/.bin/mocha \ --require should \ --reporter spec .PHONY: testemitter-3.1.0/Readme.md000066400000000000000000000025341422710230400147020ustar00rootroot00000000000000# Emitter [![Build Status](https://travis-ci.org/component/emitter.png)](https://travis-ci.org/component/emitter) Event emitter component. ## Installation ``` $ component install component/emitter ``` ## API ### Emitter(obj) 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 var Emitter = require('emitter'); var emitter = new Emitter; emitter.emit('something'); ``` As a mixin: ```js var Emitter = require('emitter'); var user = { name: 'tobi' }; Emitter(user); user.emit('im a user'); ``` As a prototype mixin: ```js var Emitter = require('emitter'); Emitter(User.prototype); ``` ### Emitter#on(event, fn) Register an `event` handler `fn`. ### Emitter#once(event, fn) Register a single-shot `event` handler `fn`, removed immediately after it is invoked the first time. ### Emitter#off(event, fn) * 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. ### Emitter#emit(event, ...) Emit an `event` with variable option args. ### Emitter#listeners(event) Return an array of callbacks, or an empty array. ### Emitter#hasListeners(event) Check if this emitter has `event` handlers. ## License MIT emitter-3.1.0/component.json000066400000000000000000000003271422710230400160560ustar00rootroot00000000000000{ "name": "emitter", "repo": "component/emitter", "description": "Event emitter", "keywords": [ "emitter", "events" ], "version": "1.3.0", "scripts": [ "index.js" ], "license": "MIT" } emitter-3.1.0/index.d.ts000066400000000000000000000127601422710230400150660ustar00rootroot00000000000000/** * An events map is an interface that maps event names to their value, which * represents the type of the `on` listener. */ export interface EventsMap { [event: string]: any; } /** * The default events map, used if no EventsMap is given. Using this EventsMap * is equivalent to accepting all event names, and any data. */ export interface DefaultEventsMap { [event: string]: (...args: any[]) => void; } /** * Returns a union type containing all the keys of an event map. */ export type EventNames = keyof Map & (string | symbol); /** The tuple type representing the parameters of an event listener */ export type EventParams< Map extends EventsMap, Ev extends EventNames > = Parameters; /** * The event names that are either in ReservedEvents or in UserEvents */ export type ReservedOrUserEventNames< ReservedEventsMap extends EventsMap, UserEvents extends EventsMap > = EventNames | EventNames; /** * Type of a listener of a user event or a reserved event. If `Ev` is in * `ReservedEvents`, the reserved event listener is returned. */ export type ReservedOrUserListener< ReservedEvents extends EventsMap, UserEvents extends EventsMap, Ev extends ReservedOrUserEventNames > = FallbackToUntypedListener< Ev extends EventNames ? ReservedEvents[Ev] : Ev extends EventNames ? UserEvents[Ev] : never >; /** * Returns an untyped listener type if `T` is `never`; otherwise, returns `T`. * * This is a hack to mitigate https://github.com/socketio/socket.io/issues/3833. * Needed because of https://github.com/microsoft/TypeScript/issues/41778 */ type FallbackToUntypedListener = [T] extends [never] ? (...args: any[]) => void | Promise : T; /** * Strictly typed version of an `EventEmitter`. A `TypedEventEmitter` takes type * parameters for mappings of event names to event data types, and strictly * types method calls to the `EventEmitter` according to these event maps. * * @typeParam ListenEvents - `EventsMap` of user-defined events that can be * listened to with `on` or `once` * @typeParam EmitEvents - `EventsMap` of user-defined events that can be * emitted with `emit` * @typeParam ReservedEvents - `EventsMap` of reserved events, that can be * emitted by socket.io with `emitReserved`, and can be listened to with * `listen`. */ export class Emitter< ListenEvents extends EventsMap, EmitEvents extends EventsMap, ReservedEvents extends EventsMap = {} > { /** * Adds the `listener` function as an event listener for `ev`. * * @param ev Name of the event * @param listener Callback function */ on>( ev: Ev, listener: ReservedOrUserListener ): this; /** * Adds a one-time `listener` function as an event listener for `ev`. * * @param ev Name of the event * @param listener Callback function */ once>( ev: Ev, listener: ReservedOrUserListener ): this; /** * Removes the `listener` function as an event listener for `ev`. * * @param ev Name of the event * @param listener Callback function */ off>( ev?: Ev, listener?: ReservedOrUserListener ): this; /** * Emits an event. * * @param ev Name of the event * @param args Values to send to listeners of this event */ emit>( ev: Ev, ...args: EventParams ): this; /** * Emits a reserved event. * * This method is `protected`, so that only a class extending * `StrictEventEmitter` can emit its own reserved events. * * @param ev Reserved event name * @param args Arguments to emit along with the event */ protected emitReserved>( ev: Ev, ...args: EventParams ): this; /** * Returns the listeners listening to an event. * * @param event Event name * @returns Array of listeners subscribed to `event` */ listeners>( event: Ev ): ReservedOrUserListener[]; /** * Returns true if there is a listener for this event. * * @param event Event name * @returns boolean */ hasListeners< Ev extends ReservedOrUserEventNames >(event: Ev): boolean; /** * Removes the `listener` function as an event listener for `ev`. * * @param ev Name of the event * @param listener Callback function */ removeListener< Ev extends ReservedOrUserEventNames >( ev?: Ev, listener?: ReservedOrUserListener ): this; /** * Removes all `listener` function as an event listener for `ev`. * * @param ev Name of the event */ removeAllListeners< Ev extends ReservedOrUserEventNames >(ev?: Ev): this; } emitter-3.1.0/index.js000066400000000000000000000064431422710230400146330ustar00rootroot00000000000000 /** * Expose `Emitter`. */ exports.Emitter = Emitter; /** * Initialize a new `Emitter`. * * @api public */ function Emitter(obj) { if (obj) return mixin(obj); } /** * Mixin the emitter properties. * * @param {Object} obj * @return {Object} * @api private */ function mixin(obj) { for (var key in Emitter.prototype) { obj[key] = Emitter.prototype[key]; } return obj; } /** * Listen on the given `event` with `fn`. * * @param {String} event * @param {Function} fn * @return {Emitter} * @api public */ Emitter.prototype.on = Emitter.prototype.addEventListener = function(event, fn){ this._callbacks = this._callbacks || {}; (this._callbacks['$' + event] = this._callbacks['$' + event] || []) .push(fn); return this; }; /** * Adds an `event` listener that will be invoked a single * time then automatically removed. * * @param {String} event * @param {Function} fn * @return {Emitter} * @api public */ Emitter.prototype.once = function(event, fn){ function on() { this.off(event, on); fn.apply(this, arguments); } on.fn = fn; this.on(event, on); return this; }; /** * Remove the given callback for `event` or all * registered callbacks. * * @param {String} event * @param {Function} fn * @return {Emitter} * @api public */ Emitter.prototype.off = Emitter.prototype.removeListener = Emitter.prototype.removeAllListeners = Emitter.prototype.removeEventListener = function(event, fn){ this._callbacks = this._callbacks || {}; // all if (0 == arguments.length) { this._callbacks = {}; return this; } // specific event var callbacks = this._callbacks['$' + event]; if (!callbacks) return this; // remove all handlers if (1 == arguments.length) { delete this._callbacks['$' + event]; return this; } // remove specific handler var cb; for (var i = 0; i < callbacks.length; i++) { cb = callbacks[i]; if (cb === fn || cb.fn === fn) { callbacks.splice(i, 1); break; } } // Remove event specific arrays for event types that no // one is subscribed for to avoid memory leak. if (callbacks.length === 0) { delete this._callbacks['$' + event]; } return this; }; /** * Emit `event` with the given args. * * @param {String} event * @param {Mixed} ... * @return {Emitter} */ Emitter.prototype.emit = function(event){ this._callbacks = this._callbacks || {}; var args = new Array(arguments.length - 1) , callbacks = this._callbacks['$' + event]; for (var i = 1; i < arguments.length; i++) { args[i - 1] = arguments[i]; } if (callbacks) { callbacks = callbacks.slice(0); for (var i = 0, len = callbacks.length; i < len; ++i) { callbacks[i].apply(this, args); } } return this; }; // alias used for reserved events (protected method) Emitter.prototype.emitReserved = Emitter.prototype.emit; /** * Return array of callbacks for `event`. * * @param {String} event * @return {Array} * @api public */ Emitter.prototype.listeners = function(event){ this._callbacks = this._callbacks || {}; return this._callbacks['$' + event] || []; }; /** * Check if this emitter has `event` handlers. * * @param {String} event * @return {Boolean} * @api public */ Emitter.prototype.hasListeners = function(event){ return !! this.listeners(event).length; }; emitter-3.1.0/index.mjs000066400000000000000000000063571422710230400150140ustar00rootroot00000000000000/** * Initialize a new `Emitter`. * * @api public */ export function Emitter(obj) { if (obj) return mixin(obj); } /** * Mixin the emitter properties. * * @param {Object} obj * @return {Object} * @api private */ function mixin(obj) { for (var key in Emitter.prototype) { obj[key] = Emitter.prototype[key]; } return obj; } /** * Listen on the given `event` with `fn`. * * @param {String} event * @param {Function} fn * @return {Emitter} * @api public */ Emitter.prototype.on = Emitter.prototype.addEventListener = function(event, fn){ this._callbacks = this._callbacks || {}; (this._callbacks['$' + event] = this._callbacks['$' + event] || []) .push(fn); return this; }; /** * Adds an `event` listener that will be invoked a single * time then automatically removed. * * @param {String} event * @param {Function} fn * @return {Emitter} * @api public */ Emitter.prototype.once = function(event, fn){ function on() { this.off(event, on); fn.apply(this, arguments); } on.fn = fn; this.on(event, on); return this; }; /** * Remove the given callback for `event` or all * registered callbacks. * * @param {String} event * @param {Function} fn * @return {Emitter} * @api public */ Emitter.prototype.off = Emitter.prototype.removeListener = Emitter.prototype.removeAllListeners = Emitter.prototype.removeEventListener = function(event, fn){ this._callbacks = this._callbacks || {}; // all if (0 == arguments.length) { this._callbacks = {}; return this; } // specific event var callbacks = this._callbacks['$' + event]; if (!callbacks) return this; // remove all handlers if (1 == arguments.length) { delete this._callbacks['$' + event]; return this; } // remove specific handler var cb; for (var i = 0; i < callbacks.length; i++) { cb = callbacks[i]; if (cb === fn || cb.fn === fn) { callbacks.splice(i, 1); break; } } // Remove event specific arrays for event types that no // one is subscribed for to avoid memory leak. if (callbacks.length === 0) { delete this._callbacks['$' + event]; } return this; }; /** * Emit `event` with the given args. * * @param {String} event * @param {Mixed} ... * @return {Emitter} */ Emitter.prototype.emit = function(event){ this._callbacks = this._callbacks || {}; var args = new Array(arguments.length - 1) , callbacks = this._callbacks['$' + event]; for (var i = 1; i < arguments.length; i++) { args[i - 1] = arguments[i]; } if (callbacks) { callbacks = callbacks.slice(0); for (var i = 0, len = callbacks.length; i < len; ++i) { callbacks[i].apply(this, args); } } return this; }; // alias used for reserved events (protected method) Emitter.prototype.emitReserved = Emitter.prototype.emit; /** * Return array of callbacks for `event`. * * @param {String} event * @return {Array} * @api public */ Emitter.prototype.listeners = function(event){ this._callbacks = this._callbacks || {}; return this._callbacks['$' + event] || []; }; /** * Check if this emitter has `event` handlers. * * @param {String} event * @return {Boolean} * @api public */ Emitter.prototype.hasListeners = function(event){ return !! this.listeners(event).length; }; emitter-3.1.0/package.json000066400000000000000000000010611422710230400154430ustar00rootroot00000000000000{ "name": "@socket.io/component-emitter", "description": "Event emitter", "version": "3.1.0", "license": "MIT", "devDependencies": { "mocha": "*", "should": "*" }, "component": { "scripts": { "emitter/index.js": "index.js" } }, "main": "index.js", "module": "index.mjs", "types": "index.d.ts", "repository": { "type": "git", "url": "https://github.com/socketio/emitter.git" }, "scripts": { "test": "make test" }, "files": [ "index.js", "index.mjs", "index.d.ts", "LICENSE" ] } emitter-3.1.0/test/000077500000000000000000000000001422710230400141365ustar00rootroot00000000000000emitter-3.1.0/test/emitter.js000066400000000000000000000127771422710230400161630ustar00rootroot00000000000000 var { Emitter } = require('..'); function Custom() { Emitter.call(this) } Custom.prototype.__proto__ = Emitter.prototype; describe('Custom', function(){ describe('with Emitter.call(this)', function(){ it('should work', function(done){ var emitter = new Custom; emitter.on('foo', done); emitter.emit('foo'); }) }) }) describe('Emitter', function(){ describe('.on(event, fn)', function(){ it('should add listeners', function(){ var emitter = new Emitter; var calls = []; emitter.on('foo', function(val){ calls.push('one', val); }); emitter.on('foo', function(val){ calls.push('two', val); }); emitter.emit('foo', 1); emitter.emit('bar', 1); emitter.emit('foo', 2); calls.should.eql([ 'one', 1, 'two', 1, 'one', 2, 'two', 2 ]); }) it('should add listeners for events which are same names with methods of Object.prototype', function(){ var emitter = new Emitter; var calls = []; emitter.on('constructor', function(val){ calls.push('one', val); }); emitter.on('__proto__', function(val){ calls.push('two', val); }); emitter.emit('constructor', 1); emitter.emit('__proto__', 2); calls.should.eql([ 'one', 1, 'two', 2 ]); }) }) describe('.once(event, fn)', function(){ it('should add a single-shot listener', function(){ var emitter = new Emitter; var calls = []; emitter.once('foo', function(val){ calls.push('one', val); }); emitter.emit('foo', 1); emitter.emit('foo', 2); emitter.emit('foo', 3); emitter.emit('bar', 1); calls.should.eql([ 'one', 1 ]); }) }) describe('.off(event, fn)', function(){ it('should remove a listener', function(){ var emitter = new Emitter; var calls = []; function one() { calls.push('one'); } function two() { calls.push('two'); } emitter.on('foo', one); emitter.on('foo', two); emitter.off('foo', two); emitter.emit('foo'); calls.should.eql([ 'one' ]); }) it('should work with .once()', function(){ var emitter = new Emitter; var calls = []; function one() { calls.push('one'); } emitter.once('foo', one); emitter.once('fee', one); emitter.off('foo', one); emitter.emit('foo'); calls.should.eql([]); }) it('should work when called from an event', function(){ var emitter = new Emitter , called function b () { called = true; } emitter.on('tobi', function () { emitter.off('tobi', b); }); emitter.on('tobi', b); emitter.emit('tobi'); called.should.be.true; called = false; emitter.emit('tobi'); called.should.be.false; }); }) describe('.off(event)', function(){ it('should remove all listeners for an event', function(){ var emitter = new Emitter; var calls = []; function one() { calls.push('one'); } function two() { calls.push('two'); } emitter.on('foo', one); emitter.on('foo', two); emitter.off('foo'); emitter.emit('foo'); emitter.emit('foo'); calls.should.eql([]); }) it('should remove event array to avoid memory leak', function() { var emitter = new Emitter; var calls = []; function cb() {} emitter.on('foo', cb); emitter.off('foo', cb); emitter._callbacks.should.not.have.property('$foo'); }) it('should only remove the event array when the last subscriber unsubscribes', function() { var emitter = new Emitter; var calls = []; function cb1() {} function cb2() {} emitter.on('foo', cb1); emitter.on('foo', cb2); emitter.off('foo', cb1); emitter._callbacks.should.have.property('$foo'); }) }) describe('.off()', function(){ it('should remove all listeners', function(){ var emitter = new Emitter; var calls = []; function one() { calls.push('one'); } function two() { calls.push('two'); } emitter.on('foo', one); emitter.on('bar', two); emitter.emit('foo'); emitter.emit('bar'); emitter.off(); emitter.emit('foo'); emitter.emit('bar'); calls.should.eql(['one', 'two']); }) }) describe('.listeners(event)', function(){ describe('when handlers are present', function(){ it('should return an array of callbacks', function(){ var emitter = new Emitter; function foo(){} emitter.on('foo', foo); emitter.listeners('foo').should.eql([foo]); }) }) describe('when no handlers are present', function(){ it('should return an empty array', function(){ var emitter = new Emitter; emitter.listeners('foo').should.eql([]); }) }) }) describe('.hasListeners(event)', function(){ describe('when handlers are present', function(){ it('should return true', function(){ var emitter = new Emitter; emitter.on('foo', function(){}); emitter.hasListeners('foo').should.be.true; }) }) describe('when no handlers are present', function(){ it('should return false', function(){ var emitter = new Emitter; emitter.hasListeners('foo').should.be.false; }) }) }) }) describe('Emitter(obj)', function(){ it('should mixin', function(done){ var proto = {}; Emitter(proto); proto.on('something', done); proto.emit('something'); }) })