@irrelon/emitter 6.1.0 → 6.2.0

package/doc/Emitter.js.html

@@ -26,857 +26,608 @@
     
     <section>
         <article>
-            <pre class="prettyprint source linenums"><code>/*
- The MIT License (MIT)
-
- Copyright (c) 2014 Irrelon Software Limited
- http://www.irrelon.com
-
- 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, url 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.
-
- Source: https://github.com/irrelon/emitter
-
- Changelog:
- 	Version 2.0.11:
- 		Added cancelStatic method to allow cancelling a static event
- 	Version 2.0.7:
- 		Fixed UMD module support
- 	Version 2.0.6:
- 		Added UMD module support
- 	Version 2.0.5:
- 		Added bower version number
- 	Version 2.0.4:
- 		Allow instantiation as independent instance, updated unit tests
- 	Version 2.0.3:
- 		Documentation updates, published to bower
- 	Version 2.0.2:
- 		Documentation updates
- 	Version 2.0.1:
- 		Bug fix in this._emitters usage
- 	Version 2.0.0:
- 		Big update to bring in line with latest developments in other projects. Event emitter can
- 		now use deferEmit(), emitId(), emitStatic(), emitStaticId(), willEmit(), willEmitId().
- 	Version 1.1.9:
- 		Updated changelog correctly
- 	Version 1.1.8:
- 		Removed tons of dependencies wrongly included in main dependencies, have moved to devDependencies section of package.json
- 	Version 1.1.0:
- 		Added support for overloaded methods
- 		Added support for events with ids
- 	Version 1.0.2:
- 		Removed AMD support, added browserify support
- 		Added package.json
- 		Added once() method
- 		Added hasListener() method
- 		Published to NPM as irrelon-emitter
- 	Version 1.0.1:
- 		Added ability to extend any object with eventing capability
- 		Added AMD / Require.js support
-		 Added Node.js support
-	Version 1.0.0:
-		First commit
- */
-"use strict";
-
-var Overload = require('irrelon-overload');
-
-var EventMethods = {
-	on: new Overload({
-		/**
-		 * Attach an event listener to the passed event.
-		 * @memberof Emitter
-		 * @method on
-		 * @param {String} event The name of the event to listen for.
-		 * @param {Function} listener The method to call when the event is fired.
-		 */
-		'string, function': function (event, listener) {
-			return this.$main(event, '*', listener);
-		},
-		
-		/**
-		 * Attach an event listener to the passed event only if the passed
-		 * id matches the document id for the event being fired.
-		 * @memberof Emitter
-		 * @method on
-		 * @param {String} event The name of the event to listen for.
-		 * @param {*} id The document id to match against.
-		 * @param {Function} listener The method to call when the event is fired.
-		 */
-		'string, *, function': function (event, id, listener) {
-			return this.$main(event, id, listener);
-		},
-		
-		/**
-		 * @param event
-		 * @param id
-		 * @param listener
-		 * @return {$main}
-		 * @private
-		 */
-		'$main': function (event, id, listener) {
-			var self = this,
-				generateTimeout,
-				emitter,
-				i;
-			
-			generateTimeout = function (emitter) {
-				setTimeout(function () {
-					listener.apply(self, emitter.args);
-				}, 1);
-			};
-			
-			this._listeners = this._listeners || {};
-			this._listeners[event] = this._listeners[event] || {};
-			this._listeners[event][id] = this._listeners[event][id] || [];
-			this._listeners[event][id].push(listener);
-			
-			// Check for any static emitters, and fire the event if any exist
-			if (this._emitters &amp;&amp; this._emitters[event] &amp;&amp; this._emitters[event].length) {
-				// Emit events for each emitter
-				for (i = 0; i &lt; this._emitters[event].length; i++) {
-					emitter = this._emitters[event];
-					
-					if (id === '*' || emitter.id === id) {
-						// Call the listener out of process so that any code that expects a listener
-						// to be called at some point in the future rather than immediately on registration
-						// will not fail
-						generateTimeout(emitter);
-					}
-				}
-			}
-			
-			return this;
-		}
-	}),
-	
-	once: new Overload({
-		/**
-		 * Attach an event listener to the passed event which will only fire once.
-		 * @memberof Emitter
-		 * @method once
-		 * @param {String} event The name of the event to listen for.
-		 * @param {Function} listener The method to call when the event is fired.
-		 */
-		'string, function': function (event, listener) {
-			var self = this,
-				fired = false,
-				internalCallback = function () {
-					if (!fired) {
-						fired = true;
-						self.off(event, internalCallback);
-						listener.apply(self, arguments);
-					}
-				};
-			
-			return this.on(event, internalCallback);
-		},
-		
-		/**
-		 * Attach an event listener to the passed event only if the passed
-		 * id matches the document id for the event being fired.
-		 * @memberof Emitter
-		 * @method once
-		 * @param {String} event The name of the event to listen for.
-		 * @param {*} id The document id to match against.
-		 * @param {Function} listener The method to call when the event is fired.
-		 */
-		'string, *, function': function (event, id, listener) {
-			var self = this,
-				fired = false,
-				internalCallback = function () {
-					if (!fired) {
-						fired = true;
-						self.off(event, id, internalCallback);
-						listener.apply(self, arguments);
-					}
-				};
-			
-			return this.on(event, id, internalCallback);
-		}
-	}),
-	
-	off: new Overload({
-		/**
-		 * Cancels all event listeners for the passed event.
-		 * @memberof Emitter
-		 * @method off
-		 * @param {String} event The name of the event.
-		 * @returns {*}
-		 */
-		'string': function (event) {
-			var self = this;
-			
-			if (this._emitting) {
-				this._eventRemovalQueue = this._eventRemovalQueue || [];
-				this._eventRemovalQueue.push(function () {
-					self.off(event);
-				});
-			} else {
-				if (this._listeners &amp;&amp; this._listeners[event]) {
-					delete this._listeners[event];
-				}
-			}
-			
-			return this;
-		},
-		
-		/**
-		 * Cancels the event listener for the passed event and listener function.
-		 * @memberof Emitter
-		 * @method off
-		 * @param {String} event The event to cancel listener for.
-		 * @param {Function} listener The event listener function used in the on()
-		 * or once() call to cancel.
-		 * @returns {*}
-		 */
-		'string, function': function (event, listener) {
-			var self = this,
-				arr,
-				index;
-			
-			if (this._emitting) {
-				this._eventRemovalQueue = this._eventRemovalQueue || [];
-				this._eventRemovalQueue.push(function () {
-					self.off(event, listener);
-				});
-			} else {
-				if (typeof(listener) === 'string') {
-					if (this._listeners &amp;&amp; this._listeners[event] &amp;&amp; this._listeners[event][listener]) {
-						delete this._listeners[event][listener];
-					}
-				} else {
-					if (this._listeners &amp;&amp; this._listeners[event]) {
-						arr = this._listeners[event]['*'];
-						index = arr.indexOf(listener);
-						
-						if (index > -1) {
-							arr.splice(index, 1);
-						}
-					}
-				}
-			}
-			
-			return this;
-		},
-		
-		/**
-		 * Cancels an event listener based on an event name, id and listener function.
-		 * @memberof Emitter
-		 * @method off
-		 * @param {String} event The event to cancel listener for.
-		 * @param {String} id The ID of the event to cancel listening for.
-		 * @param {Function} listener The event listener function used in the on()
-		 * or once() call to cancel.
-		 */
-		'string, *, function': function (event, id, listener) {
-			var self = this;
-			
-			if (this._emitting) {
-				this._eventRemovalQueue = this._eventRemovalQueue || [];
-				this._eventRemovalQueue.push(function () {
-					self.off(event, id, listener);
-				});
-			} else {
-				if (this._listeners &amp;&amp; this._listeners[event] &amp;&amp; this._listeners[event][id]) {
-					var arr = this._listeners[event][id],
-						index = arr.indexOf(listener);
-					
-					if (index > -1) {
-						arr.splice(index, 1);
-					}
-				}
-			}
-		},
-		
-		/**
-		 * Cancels all listeners for an event based on the passed event name and id.
-		 * @memberof Emitter
-		 * @method off
-		 * @param {String} event The event name to cancel listeners for.
-		 * @param {*} id The ID to cancel all listeners for.
-		 */
-		'string, *': function (event, id) {
-			var self = this;
-			
-			if (this._emitting) {
-				this._eventRemovalQueue = this._eventRemovalQueue || [];
-				this._eventRemovalQueue.push(function () {
-					self.off(event, id);
-				});
-			} else {
-				if (this._listeners &amp;&amp; this._listeners[event] &amp;&amp; this._listeners[event][id]) {
-					// Kill all listeners for this event id
-					delete this._listeners[event][id];
-				}
-			}
-		}
-	}),
-	
-	emit: new Overload({
-		/**
-		 * Emit an event.
-		 * @memberof Emitter
-		 * @method emit
-		 * @param {String} event The event to emit.
-		 * @returns {*}
-		 */
-		'string': function (event) {
-			// Fire global listeners
-			return this.$main(event);
-		},
-		
-		/**
-		 * Emit an event with data.
-		 * @memberof Emitter
-		 * @method emit
-		 * @param {String} event The event to emit.
-		 * @param {*} data Data to emit with the event.
-		 * @returns {*}
-		 */
-		'string, ...': function (event, data) {
-			// Fire global listeners first
-			this.$main.apply(this, arguments);
-			
-			return this;
-		},
-		
-		/**
-		 * Handles emitting events, is an internal method not called directly.
-		 * @param {String} event The name of the event to emit.
-		 * @param {*} data The data to emit with the event.
-		 * @returns {*}
-		 * @private
-		 */
-		'$main': function (event, data) {
-			var id = '*';
-			this._listeners = this._listeners || {};
-			this._emitting = true;
-			
-			if (this._listeners[event]) {
-				var arrIndex,
-					arrCount,
-					tmpFunc,
-					arr;
-				
-				// Handle global emit
-				if (this._listeners[event][id]) {
-					arr = this._listeners[event][id];
-					arrCount = arr.length;
-					
-					for (arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
-						// Check we have a function to execute
-						tmpFunc = arr[arrIndex];
-						
-						if (typeof tmpFunc === 'function') {
-							tmpFunc.apply(this, Array.prototype.slice.call(arguments, 1));
-						}
-					}
-				}
-			}
-			
-			this._emitting = false;
-			this._processRemovalQueue();
-			
-			return this;
-		}
-	}),
-	
-	emitId: new Overload({
-		'string': function (event) {
-			throw('Missing id from emitId call!');
-		},
-		
-		'string, *': function (event, id) {
-			return this.$main(event, id);
-		},
-		
-		'string, *, ...': function (event, id) {
-			// Fire global listeners first
-			this.$main.apply(this, arguments);
-			
-			return this;
-		},
-		
-		'$main': function (event, id, data) {
-			this._listeners = this._listeners || {};
-			this._emitting = true;
-			
-			if (this._listeners[event]) {
-				var arrIndex,
-					arrCount,
-					tmpFunc,
-					arr;
-				
-				// Handle global emit
-				if (this._listeners[event]['*']) {
-					arr = this._listeners[event]['*'];
-					arrCount = arr.length;
-					
-					for (arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
-						// Check we have a function to execute
-						tmpFunc = arr[arrIndex];
-						
-						if (typeof tmpFunc === 'function') {
-							tmpFunc.apply(this, Array.prototype.slice.call(arguments, 2));
-						}
-					}
-				}
-				
-				// Handle id emit
-				if (this._listeners[event][id]) {
-					arr = this._listeners[event][id];
-					arrCount = arr.length;
-					
-					for (arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
-						// Check we have a function to execute
-						tmpFunc = arr[arrIndex];
-						
-						if (typeof tmpFunc === 'function') {
-							tmpFunc.apply(this, Array.prototype.slice.call(arguments, 2));
-						}
-					}
-				}
-			}
-			
-			this._emitting = false;
-			this._processRemovalQueue();
-			
-			return this;
-		}
-	}),
-	
-	emitStatic: new Overload({
-		/**
-		 * Emit an event that will fire on listeners even when the listener
-		 * is registered AFTER the event has been emitted.
-		 * @memberof Emitter
-		 * @method emitStatic
-		 * @param {String} event The event to emit.
-		 * @returns {*}
-		 */
-		'string': function (event) {
-			// Fire global listeners
-			return this.$main(event);
-		},
-		
-		/**
-		 * Emit an event with data that will fire on listeners even when the listener
-		 * is registered AFTER the event has been emitted.
-		 * @memberof Emitter
-		 * @method emitStatic
-		 * @param {String} event The event to emit.
-		 * @param {*} data Data to emit with the event.
-		 * @returns {*}
-		 */
-		'string, ...': function (event, data) {
-			// Fire global listeners first
-			this.$main.apply(this, arguments);
-			
-			return this;
-		},
-		
-		/**
-		 * Handles emitting events, is an internal method not called directly.
-		 * @param {String} event The name of the event to emit.
-		 * @param {*} data The data to emit with the event.
-		 * @returns {*}
-		 * @private
-		 */
-		'$main': function (event, data) {
-			var id = '*';
-			this._listeners = this._listeners || {};
-			this._emitting = true;
-			
-			if (this._listeners[event]) {
-				var arrIndex,
-					arrCount,
-					tmpFunc,
-					arr;
-				
-				// Handle global emit
-				if (this._listeners[event][id]) {
-					arr = this._listeners[event][id];
-					arrCount = arr.length;
-					
-					for (arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
-						// Check we have a function to execute
-						tmpFunc = arr[arrIndex];
-						
-						if (typeof tmpFunc === 'function') {
-							tmpFunc.apply(this, Array.prototype.slice.call(arguments, 1));
-						}
-					}
-				}
-			}
-			
-			this._emitting = false;
-			
-			this._emitters = this._emitters || {};
-			this._emitters[event] = this._emitters[event] || [];
-			this._emitters[event].push({
-				id: '*',
-				args: Array.prototype.slice.call(arguments, 1)
-			});
-			
-			this._processRemovalQueue();
-			
-			return this;
-		}
-	}),
-	
-	emitStaticId: new Overload({
-		/**
-		 * Require an id to emit.
-		 * @memberof Emitter
-		 * @method emitStaticId
-		 * @param event
-		 */
-		'string': function (event) {
-			throw('Missing id from emitId call!');
-		},
-		
-		/**
-		 * Emit an event that will fire on listeners even when the listener
-		 * is registered AFTER the event has been emitted.
-		 * @memberof Emitter
-		 * @method emitStaticId
-		 * @param {String} event The event to emit.
-		 * @param {String} id The id of the event to emit.
-		 * @returns {*}
-		 */
-		'string, *': function (event, id) {
-			return this.$main(event, id);
-		},
-		
-		/**
-		 * Emit an event that will fire on listeners even when the listener
-		 * is registered AFTER the event has been emitted.
-		 * @memberof Emitter
-		 * @method emitStaticId
-		 * @param {String} event The event to emit.
-		 * @param {String} id The id of the event to emit.
-		 * @param {*=} data The data to emit with the event.
-		 * @returns {*}
-		 */
-		'string, *, ...': function (event, id, data) {
-			// Fire global listeners first
-			this.$main.apply(this, arguments);
-			
-			return this;
-		},
-		
-		/**
-		 * Handles emitting events, is an internal method not called directly.
-		 * @param {String} event The name of the event to emit.
-		 * @param {String} id The id of the event to emit.
-		 * @param {*} data The data to emit with the event.
-		 * @returns {*}
-		 * @private
-		 */
-		'$main': function (event, id, data) {
-			this._listeners = this._listeners || {};
-			this._emitting = true;
-			
-			if (this._listeners[event]) {
-				var arrIndex,
-					arrCount,
-					tmpFunc,
-					arr;
-				
-				// Handle global emit
-				if (this._listeners[event]['*']) {
-					arr = this._listeners[event]['*'];
-					arrCount = arr.length;
-					
-					for (arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
-						// Check we have a function to execute
-						tmpFunc = arr[arrIndex];
-						
-						if (typeof tmpFunc === 'function') {
-							tmpFunc.apply(this, Array.prototype.slice.call(arguments, 2));
-						}
-					}
-				}
-				
-				// Handle id emit
-				if (this._listeners[event][id]) {
-					arr = this._listeners[event][id];
-					arrCount = arr.length;
-					
-					for (arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
-						// Check we have a function to execute
-						tmpFunc = arr[arrIndex];
-						
-						if (typeof tmpFunc === 'function') {
-							tmpFunc.apply(this, Array.prototype.slice.call(arguments, 2));
-						}
-					}
-				}
-			}
-			
-			this._emitting = false;
-			
-			this._emitters = this._emitters || {};
-			this._emitters[event] = this._emitters[event] || [];
-			this._emitters[event].push({
-				id: id,
-				args: Array.prototype.slice.call(arguments, 2)
-			});
-			
-			this._processRemovalQueue();
-			
-			return this;
-		}
-	}),
-	
-	cancelStatic: new Overload({
-		/**
-		 * Remove a static event emitter.
-		 * @memberof Emitter
-		 * @method emitStatic
-		 * @param {String} event The event to remove static emitter for.
-		 * @returns {*}
-		 */
-		'string': function (event) {
-			// Fire global listeners
-			return this.$main(event);
-		},
-		
-		/**
-		 * Handles removing emitters, is an internal method not called directly.
-		 * @param {String} event The event to remove static emitter for.
-		 * @returns {*}
-		 * @private
-		 */
-		'$main': function (event) {
-			this._emitters = this._emitters || {};
-			this._emitters[event] = [];
-			
-			return this;
-		}
-	}),
-	
-	/**
-	 * Checks if an event has any event listeners or not.
-	 * @memberof Emitter
-	 * @method willEmit
-	 * @param {String} event The name of the event to check for.
-	 * @returns {boolean} True if one or more event listeners are registered for
-	 * the event. False if none are found.
-	 */
-	willEmit: function (event) {
-		var id = '*';
-		
-		if (this._listeners &amp;&amp; this._listeners[event]) {
-			var arrIndex,
-				arrCount,
-				tmpFunc,
-				arr;
-			
-			// Handle global emit
-			if (this._listeners[event][id]) {
-				arr = this._listeners[event][id];
-				arrCount = arr.length;
-				
-				for (arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
-					// Check we have a function to execute
-					tmpFunc = arr[arrIndex];
-					
-					if (typeof tmpFunc === 'function') {
-						return true;
-					}
-				}
-			}
-		}
-		
-		return false;
-	},
-	
-	/**
-	 * Checks if an event has any event listeners or not based on the passed id.
-	 * @memberof Emitter
-	 * @method willEmitId
-	 * @param {String} event The name of the event to check for.
-	 * @param {String} id The event ID to check for.
-	 * @returns {boolean} True if one or more event listeners are registered for
-	 * the event. False if none are found.
-	 */
-	willEmitId: function (event, id) {
-		if (this._listeners &amp;&amp; this._listeners[event]) {
-			var arrIndex,
-				arrCount,
-				tmpFunc,
-				arr;
-			
-			// Handle global emit
-			if (this._listeners[event]['*']) {
-				arr = this._listeners[event]['*'];
-				arrCount = arr.length;
-				
-				for (arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
-					// Check we have a function to execute
-					tmpFunc = arr[arrIndex];
-					
-					if (typeof tmpFunc === 'function') {
-						return true;
-					}
-				}
-			}
-			
-			// Handle id emit
-			if (this._listeners[event][id]) {
-				arr = this._listeners[event][id];
-				arrCount = arr.length;
-				
-				for (arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
-					// Check we have a function to execute
-					tmpFunc = arr[arrIndex];
-					
-					if (typeof tmpFunc === 'function') {
-						return true;
-					}
-				}
-			}
-		}
-		
-		return false;
-	},
-	
-	/**
-	 * If events are cleared with the off() method while the event emitter is
-	 * actively processing any events then the off() calls get added to a
-	 * queue to be executed after the event emitter is finished. This stops
-	 * errors that might occur by potentially modifying the event queue while
-	 * the emitter is running through them. This method is called after the
-	 * event emitter is finished processing.
-	 * @private
-	 */
-	_processRemovalQueue: function () {
-		var i;
-		
-		if (this._eventRemovalQueue &amp;&amp; this._eventRemovalQueue.length) {
-			// Execute each removal call
-			for (i = 0; i &lt; this._eventRemovalQueue.length; i++) {
-				this._eventRemovalQueue[i]();
-			}
-			
-			// Clear the removal queue
-			this._eventRemovalQueue = [];
-		}
-	},
-	
-	/**
-	 * Queues an event to be fired. This has automatic de-bouncing so that any
-	 * events of the same type that occur within 100 milliseconds of a previous
-	 * one will all be wrapped into a single emit rather than emitting tons of
-	 * events for lots of chained inserts etc. Only the data from the last
-	 * de-bounced event will be emitted.
-	 * @memberof Emitter
-	 * @method deferEmit
-	 * @param {String} eventName The name of the event to emit.
-	 * @param {*=} data Optional data to emit with the event.
-	 */
-	deferEmit: function (eventName, data) {
-		var self = this,
-			args;
-		
-		if (!this._noEmitDefer &amp;&amp; (!this._db || (this._db &amp;&amp; !this._db._noEmitDefer))) {
-			args = arguments;
-			
-			// Check for an existing timeout
-			this._deferTimeout = this._deferTimeout || {};
-			if (this._deferTimeout[eventName]) {
-				clearTimeout(this._deferTimeout[eventName]);
-			}
-			
-			// Set a timeout
-			this._deferTimeout[eventName] = setTimeout(function () {
-				self.emit.apply(self, args);
-			}, 1);
-		} else {
-			this.emit.apply(this, arguments);
-		}
-		
-		return this;
-	}
-};
-
+            <pre class="prettyprint source linenums"><code>export var ListenerReturnFlag;
+(function (ListenerReturnFlag) {
+    ListenerReturnFlag["none"] = "!+_NONE";
+    ListenerReturnFlag["cancel"] = "!+_CANCEL";
+})(ListenerReturnFlag || (ListenerReturnFlag = {}));
 /**
- * @class Emitter
- * @param obj
- * @param {Boolean} prototypeMode Defaults to true. Set to true to add emitter
- * methods to the the passed object's prototype property e.g. obj.prototype.on
- * = emitter.on. Set to false to add emitter methods the object directly e.g.
- * obj.on = emitter.on.
- * @constructor
+ * Creates a new class with the ability to emit events.
  */
-var Emitter = function (obj, prototypeMode) {
-	var operateOnObject;
-	
-	if (obj === undefined &amp;&amp; prototypeMode === undefined) {
-		obj = {};
-		prototypeMode = false;
-	}
-	
-	if (typeof obj === 'boolean' &amp;&amp; prototypeMode === undefined) {
-		prototypeMode = obj;
-		obj = {};
-	}
-	
-	if (prototypeMode === undefined) {
-		prototypeMode = true;
-	}
-	
-	if (typeof obj !== 'object' &amp;&amp; typeof obj !== 'function') {
-		throw new Error('Cannot operate on a non-object / non-function passed as first argument!');
-	}
-	
-	if (prototypeMode) {
-		if (obj.prototype === undefined) {
-			throw new Error('Cannot modify prototype of passed object, it has no prototype property! Was it instantiated with the new operator correctly?');
-		}
-		
-		operateOnObject = obj.prototype;
-	} else {
-		operateOnObject = obj;
-	}
-	
-	// Convert the object prototype to have eventing capability
-	operateOnObject.on = EventMethods.on;
-	operateOnObject.off = EventMethods.off;
-	operateOnObject.once = EventMethods.once;
-	operateOnObject.emit = EventMethods.emit;
-	operateOnObject.emitId = EventMethods.emitId;
-	operateOnObject.emitStatic = EventMethods.emitStatic;
-	operateOnObject.emitStaticId = EventMethods.emitStaticId;
-	operateOnObject.cancelStatic = EventMethods.cancelStatic;
-	operateOnObject.deferEmit = EventMethods.deferEmit;
-	operateOnObject.willEmit = EventMethods.willEmit;
-	operateOnObject.willEmitId = EventMethods.willEmitId;
-	operateOnObject._processRemovalQueue = EventMethods._processRemovalQueue;
-	
-	return obj;
-};
-
-Emitter.prototype = EventMethods;
-
-module.exports = Emitter;</code></pre>
+export class Emitter {
+    _eventsEmitting = false;
+    _eventRemovalQueue = [];
+    _eventListeners = {};
+    _eventStaticEmitters = {};
+    _eventsAllowDefer = false;
+    _eventsDeferTimeouts = {};
+    _dispatchWindowEventsEnabled = false;
+    _dispatchPrefix;
+    constructor(dispatchPrefix, shouldDispatchWindowEvents = false) {
+        this._dispatchPrefix = dispatchPrefix;
+        this._dispatchWindowEventsEnabled = shouldDispatchWindowEvents;
+    }
+    dispatchWindowEventsEnabled(shouldDispatchWindowEvents) {
+        this._dispatchWindowEventsEnabled = shouldDispatchWindowEvents;
+    }
+    /**
+     * Attach an event listener to the passed event only if the passed
+     * id matches the id for the event being fired.
+     * @param eventName The name of the event to listen for.
+     * @param id The id to match against.
+     * @param listener The method to call when the event is fired.
+     * @returns The emitter instance.
+     */
+    _on(eventName, id, listener) {
+        const generateTimeout = (emitter) => {
+            setTimeout(() => {
+                listener(...emitter.args);
+            }, 1);
+        };
+        this._eventListeners = this._eventListeners || {};
+        const nonNullableEventListeners = (this._eventListeners[eventName] = this._eventListeners[eventName] || {});
+        nonNullableEventListeners[id] = nonNullableEventListeners[id] || [];
+        nonNullableEventListeners[id].push(listener);
+        // Check for any static emitters, and fire the event if any exist
+        if (!this._eventStaticEmitters || !this._eventStaticEmitters[eventName] || !this._eventStaticEmitters[eventName].length)
+            return this;
+        // Emit events for each emitter
+        for (let i = 0; i &lt; this._eventStaticEmitters[eventName].length; i++) {
+            const emitter = this._eventStaticEmitters[eventName][i];
+            if (id === "*" || emitter.id === id) {
+                // Call the listener out of process so that any code that expects a listener
+                // to be called at some point in the future rather than immediately on registration
+                // will not fail
+                generateTimeout(emitter);
+            }
+        }
+        return this;
+    }
+    /**
+     * Attach an event listener to the passed event only if the passed
+     * id matches the document id for the event being fired.
+     * @param eventName The name of the event to listen for.
+     * @param id The id to match against.
+     * @param listener The method to call when the event is fired.
+     * @returns The emitter instance.
+     */
+    _once(eventName, id, listener) {
+        let fired = false;
+        let originalReturnData;
+        const internalCallback = (...args) => {
+            if (fired)
+                return originalReturnData;
+            fired = true;
+            this.off(eventName, id, internalCallback);
+            originalReturnData = listener(...args);
+            return originalReturnData;
+        };
+        return this.on(eventName, id, internalCallback);
+    }
+    /**
+     * Cancels an event listener based on an event name, id and listener function.
+     * @param eventName The event to cancel listener for.
+     * @param id The ID of the event to cancel listening for.
+     * @param listener The event listener function used in the on()
+     * or once() call to cancel.
+     * @returns The emitter instance.
+     */
+    _off(eventName, id, listener) {
+        // If the event name doesn't have any listeners, exit early
+        if (!this._eventListeners || !this._eventListeners[eventName] || !this._eventListeners[eventName][id])
+            return this;
+        // If we are emitting events at the moment, don't remove this listener
+        // until the process has completed, so we queue for removal instead
+        if (this._eventsEmitting) {
+            this._eventRemovalQueue = this._eventRemovalQueue || [];
+            this._eventRemovalQueue.push(() => {
+                this.off(eventName, id, listener);
+            });
+            return this;
+        }
+        // Check if we have no specific listener... in this case
+        // we want to remove all listeners for an id
+        if (!listener) {
+            if (id === "*") {
+                // The id is "all" and no listener was provided so delete all
+                // event listeners for this event name
+                delete this._eventListeners[eventName];
+                return this;
+            }
+            // No listener provided, delete all listeners for this id
+            delete this._eventListeners[eventName][id];
+            return this;
+        }
+        const arr = this._eventListeners[eventName][id] || [];
+        const index = arr.indexOf(listener);
+        if (index > -1) {
+            arr.splice(index, 1);
+        }
+        return this;
+    }
+    /**
+     * Creates an event listener that listens for any and all events
+     * emitted.
+     */
+    onAny(listener) {
+        this.on("*", listener);
+    }
+    on(eventName, idOrListener, listener) {
+        if (typeof idOrListener === "string") {
+            return this._on(eventName, idOrListener, listener);
+        }
+        return this._on(eventName, "*", idOrListener);
+    }
+    once(eventName, ...rest) {
+        const restTypes = rest.map((arg) => typeof arg);
+        if (restTypes[0] === "function") {
+            return this._once(eventName, "*", rest[0]);
+        }
+        return this._once(eventName, rest[0], rest[1]);
+    }
+    overwrite(eventName, ...rest) {
+        const restTypes = rest.map((arg) => typeof arg);
+        if (restTypes[0] === "function") {
+            this.off(eventName);
+            return this._on(eventName, "*", rest[0]);
+        }
+        this.off(eventName, rest[0]);
+        return this._on(eventName, rest[0], rest[1]);
+    }
+    /**
+     * Removes an event listener that listens for any and all events
+     * emitted.
+     */
+    offAny(listener) {
+        this.off("*", listener);
+    }
+    off(eventName, ...rest) {
+        if (rest.length === 0) {
+            // Only event was provided, use * as the id to mean "any without"
+            // a specific id
+            return this._off(eventName, "*");
+        }
+        const restTypes = rest.map((arg) => typeof arg);
+        if (restTypes[0] === "function") {
+            // The first arg after the event name was a function (listener)
+            // so remove listening for events for this specific listener
+            return this._off(eventName, "*", rest[0]);
+        }
+        // Both id and listener were provided, remove for the specific id
+        return this._off(eventName, rest[0], rest[1]);
+    }
+    _emitToSingleListener(listener, data) {
+        return listener(...data);
+    }
+    _emitToArrayOfListeners(arr, data) {
+        const arrCount = arr.length;
+        const resultArr = [];
+        for (let arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
+            // Check we have a function to execute
+            const tmpFunc = arr[arrIndex];
+            if (typeof tmpFunc !== "function") {
+                continue;
+            }
+            const eventListenerResponse = tmpFunc(...data);
+            resultArr.push(eventListenerResponse);
+            if (eventListenerResponse === ListenerReturnFlag.cancel) {
+                // Cancel further event processing
+                break;
+            }
+        }
+        return resultArr;
+    }
+    /**
+     * Dispatches an event originating in our emitter to the browser's
+     * window object.
+     * @param eventName The name of the event to emit. This gets prefixed with the
+     * dispatch prefix if one is set.
+     * @param data
+     */
+    _emitToWindowDispatch(eventName, data) {
+        if (typeof window === "undefined")
+            return;
+        if (!this._dispatchWindowEventsEnabled) {
+            return;
+        }
+        const finalEventName = (this._dispatchPrefix ? `${this._dispatchPrefix}.${eventName}` : eventName);
+        window.dispatchEvent(new CustomEvent(finalEventName, { detail: data }));
+    }
+    /**
+     * Call an event listener by name. The `rpc()` function differs from `emit()` in
+     * that it will only call and return data from the first event listener for the
+     * event rather than all event listeners. If you have more than one event listener
+     * assigned to the event, all others except the first will be ignored and will
+     * not receive the event.
+     * @param eventName The name of the event to call the listener for.
+     * @param {...any} data The arguments to send to the listening method.
+     * If you are sending multiple arguments, separate them with a comma so
+     * that they are received by the function as separate arguments.
+     * @return {number}
+     * @example #Call the Event Listener
+     *     // Emit the event named "hello"
+     *     myEntity.emit('hello');
+     * @example #Call the Event Listener With Data Object
+     *     // Emit the event named "hello"
+     *     myEntity.emit('hello', {moo: true});
+     * @example #Call the Event Listener With Multiple Data Values
+     *     // Emit the event named "hello"
+     *     myEntity.emit('hello', {moo: true}, 'someString');
+     * @example #Register the Listener for Event Data
+     *     // Set a listener to listen for the data (multiple values emitted
+     *     // from an event are passed as function arguments)
+     *    myEntity.on('hello', function (arg1, arg2) {
+     *         console.log("Arguments:", arg1, arg2);
+     *         return "foo";
+     *     }
+     *
+     *     // Emit the event named "hello"
+     *     const result = myEntity.emit('hello', 'data1', 'data2');
+     *       console.log("Result:", result);
+     *
+     *     // The console output is:
+     *     //	Arguments: data1 data2
+     *     //	Result: "foo"
+     */
+    rpc(eventName, ...data) {
+        return this.rpcId(eventName, "*", ...data);
+    }
+    rpcId(eventName, id, ...data) {
+        if (!this._eventListeners || !this._eventListeners[eventName]) {
+            throw new Error("Cannot make an rpc call without at least one event listener and none were found");
+        }
+        let emitterResult;
+        this._eventsEmitting = true;
+        if (this._eventListeners[eventName][id]) {
+            // Handle id emit
+            const arr = this._eventListeners[eventName][id];
+            emitterResult = this._emitToSingleListener(arr[0], data);
+        }
+        else if (id !== "*" &amp;&amp; this._eventListeners[eventName]["*"]) {
+            // Handle wildcard emit if the id passed wasn't already a wildcard (*) id
+            const arr = this._eventListeners[eventName]["*"];
+            emitterResult = this._emitToSingleListener(arr[0], data);
+        }
+        else {
+            if (id === "*") {
+                throw new Error(`Cannot make an rpc call to event "${eventName}" without at least one event listener and none were found, register a listener via on("${eventName}", () => { ...some listener code })`);
+            }
+            throw new Error(`Cannot make an rpc call to event "${eventName}" and id "${id}" without at least one event listener and none were found, register a listener via on("${eventName}", "${id}", () => { ...some listener code })`);
+        }
+        this._eventsEmitting = false;
+        this._processRemovalQueue();
+        return emitterResult;
+    }
+    /**
+     * Emit an event by name.
+     * @param eventName The name of the event to emit.
+     * @param {...any} data The arguments to send to any listening methods.
+     * If you are sending multiple arguments, separate them with a comma so
+     * that they are received by the function as separate arguments.
+     * @return {any[]} An array of all return values from all the listeners for the event.
+     * @example #Emit an Event
+     *     // Emit the event named "hello"
+     *     myEntity.emit('hello');
+     * @example #Emit an Event With Data Object
+     *     // Emit the event named "hello"
+     *     myEntity.emit('hello', {moo: true});
+     * @example #Emit an Event With Multiple Data Values
+     *     // Emit the event named "hello"
+     *     myEntity.emit('hello', {moo: true}, 'someString');
+     * @example #Listen for Event Data
+     *     // Set a listener to listen for the data (multiple values emitted
+     *     // from an event are passed as function arguments)
+     *	   myEntity.on('hello', function (arg1, arg2) {
+     *         console.log("Arguments:", arg1, arg2);
+     *         return "foo";
+     *     }
+     *
+     *     // Emit the event named "hello"
+     *     // The result is returned as an array of all return values
+     *     // from all the listeners for the event
+     *     const result = myEntity.emit('hello', 'data1', 'data2');
+     *       console.log("Result:", result);
+     *
+     *     // The console output is:
+     *     //	Arguments: data1 data2
+     *     //	Result: ["foo"]
+     */
+    emit(eventName, ...data) {
+        this._emitToWindowDispatch(eventName, data);
+        return this.emitId(eventName, "*", ...data);
+    }
+    /**
+     * Emits an event by name and id.
+     * @param eventName The name of the event to emit.
+     * @param id The id of the event to emit.
+     * @param {...any} data The arguments to send to any listening methods.
+     * If you are sending multiple arguments, separate them with a comma so
+     * that they are received by the function as separate arguments.
+     * @return {any[]} An array of all return values from all the listeners for the event.
+     */
+    emitId(eventName, id, ...data) {
+        if (!this._eventListeners || (!this._eventListeners[eventName] &amp;&amp; !this._eventListeners["*"])) {
+            return [];
+        }
+        let emitterResult = [];
+        this._eventsEmitting = true;
+        if (this._eventListeners[eventName]) {
+            // Handle id emit
+            if (this._eventListeners[eventName][id]) {
+                const arr = this._eventListeners[eventName][id];
+                emitterResult = emitterResult.concat(this._emitToArrayOfListeners(arr, data));
+            }
+            // Handle id wildcard emit if the id passed wasn't already a wildcard (*) id
+            if (id !== "*" &amp;&amp; this._eventListeners[eventName]["*"]) {
+                const arr = this._eventListeners[eventName]["*"];
+                emitterResult = emitterResult.concat(this._emitToArrayOfListeners(arr, data));
+            }
+        }
+        if (this._eventListeners["*"]) {
+            const arr = this._eventListeners["*"]["*"];
+            emitterResult = emitterResult.concat(this._emitToArrayOfListeners(arr, [eventName, ...data]));
+        }
+        this._eventsEmitting = false;
+        this._processRemovalQueue();
+        return emitterResult;
+    }
+    /**
+     * Creates a persistent event. Once emitStatic() has been called, a
+     * persistent event is registered. Any existing event listeners will
+     * be called just like when you call emit(), however, any new
+     * listeners that are registered for this event via on() will also be
+     * called as soon as they are added.
+     * @param eventName The name of the event to emit.
+     * @param {...any} data Optional arguments to emit with the event.
+     * @returns The emitter instance.
+     * @private
+     */
+    emitStatic(eventName, ...data) {
+        const id = "*";
+        this._eventListeners = this._eventListeners || {};
+        this._eventsEmitting = true;
+        if (this._eventListeners[eventName] &amp;&amp; this._eventListeners[eventName][id]) {
+            // Handle id wildcard emit
+            const arr = this._eventListeners[eventName][id];
+            const arrCount = arr.length;
+            for (let arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
+                // Check we have a function to execute
+                const tmpFunc = arr[arrIndex];
+                if (typeof tmpFunc === "function") {
+                    tmpFunc.call(this, ...data);
+                }
+            }
+        }
+        this._eventsEmitting = false;
+        this._eventStaticEmitters = this._eventStaticEmitters || {};
+        this._eventStaticEmitters[eventName] = this._eventStaticEmitters[eventName] || [];
+        this._eventStaticEmitters[eventName].push({
+            id: "*",
+            args: data
+        });
+        this._processRemovalQueue();
+        return this;
+    }
+    /**
+     * Creates a persistent emitter record that will fire a listener if
+     * one is added for this event after the emitStatic() call has been
+     * made.
+     * @param eventName The name of the event to emit.
+     * @param id The id of the event to emit.
+     * @param {...any} data Optional arguments to emit with the event.
+     * @returns The emitter instance.
+     * @private
+     */
+    emitStaticId(eventName, id, ...data) {
+        if (!id)
+            throw new Error("Missing id from emitId call!");
+        this._eventListeners = this._eventListeners || {};
+        this._eventsEmitting = true;
+        if (this._eventListeners[eventName]) {
+            // Handle id emit
+            if (this._eventListeners[eventName][id]) {
+                const arr = this._eventListeners[eventName][id];
+                const arrCount = arr.length;
+                for (let arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
+                    // Check we have a function to execute
+                    const tmpFunc = arr[arrIndex];
+                    if (typeof tmpFunc === "function") {
+                        tmpFunc.call(this, ...data);
+                    }
+                }
+            }
+            // Handle wildcard emit
+            if (this._eventListeners[eventName]["*"]) {
+                const arr = this._eventListeners[eventName]["*"];
+                const arrCount = arr.length;
+                for (let arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
+                    // Check we have a function to execute
+                    const tmpFunc = arr[arrIndex];
+                    if (typeof tmpFunc === "function") {
+                        tmpFunc.call(this, ...data);
+                    }
+                }
+            }
+        }
+        this._eventsEmitting = false;
+        this._eventStaticEmitters = this._eventStaticEmitters || {};
+        this._eventStaticEmitters[eventName] = this._eventStaticEmitters[eventName] || [];
+        this._eventStaticEmitters[eventName].push({
+            id,
+            args: data
+        });
+        this._processRemovalQueue();
+        return this;
+    }
+    /**
+     * Handles removing emitters, is an internal method not called directly.
+     * @param eventName The event to remove static emitter for.
+     * @returns The emitter instance.
+     * @private
+     */
+    cancelStatic(eventName) {
+        this._eventStaticEmitters = this._eventStaticEmitters || {};
+        this._eventStaticEmitters[eventName] = [];
+        return this;
+    }
+    /**
+     * Checks if an event has any event listeners or not.
+     * @param eventName The name of the event to check for.
+     * @returns True if one or more event listeners are registered for
+     * the event. False if none are found.
+     */
+    willEmit(eventName) {
+        const id = "*";
+        if (!this._eventListeners || !this._eventListeners[eventName]) {
+            return false;
+        }
+        const arr = this._eventListeners[eventName][id];
+        const arrCount = arr.length;
+        for (let arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
+            // Check we have a function to execute
+            const tmpFunc = arr[arrIndex];
+            if (typeof tmpFunc === "function") {
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * Checks if an event has any event listeners or not based on the passed id.
+     * @param eventName The name of the event to check for.
+     * @param id The event ID to check for.
+     * @returns True if one or more event listeners are registered for
+     * the event. False if none are found.
+     */
+    willEmitId(eventName, id) {
+        if (!this._eventListeners || !this._eventListeners[eventName]) {
+            return false;
+        }
+        // Handle id emit
+        if (this._eventListeners[eventName][id]) {
+            const arr = this._eventListeners[eventName][id];
+            const arrCount = arr.length;
+            for (let arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
+                // Check we have a function to execute
+                const tmpFunc = arr[arrIndex];
+                if (typeof tmpFunc === "function") {
+                    return true;
+                }
+            }
+        }
+        // Handle wildcard emit
+        if (this._eventListeners[eventName]["*"]) {
+            const arr = this._eventListeners[eventName]["*"];
+            const arrCount = arr.length;
+            for (let arrIndex = 0; arrIndex &lt; arrCount; arrIndex++) {
+                // Check we have a function to execute
+                const tmpFunc = arr[arrIndex];
+                if (typeof tmpFunc === "function") {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+    /**
+     * Queues an event to be fired. This has automatic de-bouncing so that any
+     * events of the same type that occur within 100 milliseconds of a previous
+     * one will all be wrapped into a single emit rather than emitting tons of
+     * events for lots of chained inserts etc. Only the data from the last
+     * de-bounced event will be emitted.
+     * @param eventName The name of the event to emit.
+     * @param {...any} data Optional arguments to emit with the event.
+     * @returns The emitter instance.
+     */
+    deferEmit(eventName, ...data) {
+        if (!this._eventsAllowDefer) {
+            // Check for an existing timeout
+            this._eventsDeferTimeouts = this._eventsDeferTimeouts || {};
+            if (this._eventsDeferTimeouts[eventName]) {
+                clearTimeout(this._eventsDeferTimeouts[eventName]);
+            }
+            // Set a timeout
+            this._eventsDeferTimeouts[eventName] = setTimeout(() => {
+                void this.emit.call(this, eventName, ...data);
+            }, 1);
+        }
+        else {
+            void this.emit.call(this, eventName, ...data);
+        }
+        return this;
+    }
+    /**
+     * Returns true if the result from an emit() call passed as the first
+     * argument contains a cancellation flag.
+     * @param resultArr
+     */
+    didCancel(resultArr) {
+        return resultArr.findIndex((result) => result === ListenerReturnFlag.cancel) > -1;
+    }
+    /**
+     * If events are cleared with the off() method while the event emitter is
+     * actively processing any events then the off() calls get added to a
+     * queue to be executed after the event emitter is finished. This stops
+     * errors that might occur by potentially mutating the event listener array
+     * while the emitter is running through them. This method is called after
+     * the event emitter is finished processing.
+     * @private
+     */
+    _processRemovalQueue() {
+        if (!this._eventRemovalQueue || !this._eventRemovalQueue.length) {
+            return;
+        }
+        // Execute each removal call
+        for (let i = 0; i &lt; this._eventRemovalQueue.length; i++) {
+            this._eventRemovalQueue[i]();
+        }
+        // Clear the removal queue
+        this._eventRemovalQueue = [];
+    }
+}
+export function makeEmitter(obj, prototypeMode) {
+    let operateOnObject;
+    if (obj === undefined &amp;&amp; prototypeMode === undefined) {
+        obj = {};
+        prototypeMode = false;
+    }
+    if (typeof obj === "boolean" &amp;&amp; prototypeMode === undefined) {
+        prototypeMode = obj;
+        obj = {};
+    }
+    if (prototypeMode === undefined) {
+        prototypeMode = true;
+    }
+    if (typeof obj !== "object" &amp;&amp; typeof obj !== "function") {
+        throw new Error("Cannot operate on a non-object / non-function passed as first argument!");
+    }
+    if (prototypeMode) {
+        if (obj.prototype === undefined) {
+            throw new Error("Cannot modify prototype of passed object, it has no prototype property! Was it instantiated with the new operator correctly?");
+        }
+        operateOnObject = obj.prototype;
+    }
+    else {
+        operateOnObject = obj;
+    }
+    // Convert the object prototype to have eventing capability
+    operateOnObject.on = Emitter.prototype.on;
+    operateOnObject.onAny = Emitter.prototype.onAny;
+    operateOnObject.off = Emitter.prototype.off;
+    operateOnObject.offAny = Emitter.prototype.offAny;
+    operateOnObject.once = Emitter.prototype.once;
+    operateOnObject.emit = Emitter.prototype.emit;
+    operateOnObject.emitId = Emitter.prototype.emitId;
+    operateOnObject.emitStatic = Emitter.prototype.emitStatic;
+    operateOnObject.emitStaticId = Emitter.prototype.emitStaticId;
+    operateOnObject.cancelStatic = Emitter.prototype.cancelStatic;
+    operateOnObject.deferEmit = Emitter.prototype.deferEmit;
+    operateOnObject.willEmit = Emitter.prototype.willEmit;
+    operateOnObject.willEmitId = Emitter.prototype.willEmitId;
+    operateOnObject._processRemovalQueue = Emitter.prototype._processRemovalQueue;
+    return obj;
+}
+</code></pre>
         </article>
     </section>
 
@@ -892,7 +643,7 @@ module.exports = Emitter;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 22 2019 14:10:25 GMT+0000 (GMT)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Tue Sep 23 2025 16:47:15 GMT+0100 (Western European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>