@irrelon/emitter 5.0.0 → 5.0.2

package/dist/Emitter.js

@@ -1,415 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeEmitter = exports.Emitter = void 0;
-/**
- * @class Emitter
- * @constructor
- */
-class Emitter {
-    constructor(obj) {
-        this._noEmitDefer = false;
-        this._emitting = false;
-        this._listeners = {};
-        this._emitters = {};
-        this._eventRemovalQueue = [];
-        if (obj !== undefined) {
-            return (0, exports.makeEmitter)(obj);
-        }
-    }
-    /**
-     * 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.
-     * @returns {Emitter} The emitter instance.
-     */
-    _on(event, id, listener) {
-        const generateEmitterTimeout = (emitter) => {
-            setTimeout(() => {
-                listener.apply(this, 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 || !this._emitters[event] || !this._emitters[event].length)
-            return this;
-        // Emit events for each emitter
-        this._emitters[event].forEach((emitter) => {
-            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
-                generateEmitterTimeout(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.
-     * @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.
-     * @returns {Emitter} The emitter instance.
-     */
-    _once(event, id, listener) {
-        let fired = false;
-        const internalCallback = (...rest) => {
-            if (fired)
-                return;
-            fired = true;
-            this.off(event, id, internalCallback);
-            listener(...rest);
-        };
-        return this.on(event, id, internalCallback);
-    }
-    /**
-     * 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.
-     * @returns {Emitter} The emitter instance.
-     */
-    _off(event, id, listener) {
-        if (this._emitting) {
-            this._eventRemovalQueue = this._eventRemovalQueue || [];
-            this._eventRemovalQueue.push(() => {
-                this.off(event, id, listener);
-            });
-            return this;
-        }
-        if (!this._listeners || !this._listeners[event] || !this._listeners[event][id])
-            return this;
-        if (id && !listener) {
-            if (id === "*") {
-                delete this._listeners[event];
-                return this;
-            }
-            // No listener provided, delete all listeners
-            delete this._listeners[event][id];
-            return this;
-        }
-        if (!listener)
-            return this;
-        const arr = this._listeners[event][id] || [];
-        const index = arr.indexOf(listener);
-        if (index > -1) {
-            arr.splice(index, 1);
-        }
-    }
-    on(event, ...rest) {
-        const restTypes = rest.map((arg) => typeof arg);
-        if (restTypes[0] === "function") {
-            return this._on.call(this, event, "*", rest[0]);
-        }
-        return this._on.call(this, event, rest[0], rest[1]);
-    }
-    once(event, ...rest) {
-        const restTypes = rest.map((arg) => typeof arg);
-        if (restTypes[0] === "function") {
-            return this._once.call(this, event, "*", rest[0]);
-        }
-        return this._once.call(this, event, rest[0], rest[1]);
-    }
-    one(event, ...rest) {
-        const restTypes = rest.map((arg) => typeof arg);
-        if (restTypes[0] === "function") {
-            this.off(event);
-            return this._on.call(this, event, "*", rest[0]);
-        }
-        this.off(event, rest[0]);
-        return this._on.call(this, event, rest[0], rest[1]);
-    }
-    off(event, ...rest) {
-        if (rest.length === 0) {
-            // Only event was provided
-            return this._off.call(this, event, "*");
-        }
-        const restTypes = rest.map((arg) => typeof arg);
-        if (restTypes[0] === "function") {
-            return this._off.call(this, event, "*", rest[0]);
-        }
-        return this._off.call(this, event, rest[0], rest[1]);
-    }
-    /**
-     * 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 {Emitter} The emitter instance.
-     * @private
-     */
-    emit(event, ...data) {
-        const id = "*";
-        this._listeners = this._listeners || {};
-        this._emitting = true;
-        if (this._listeners[event] && this._listeners[event][id]) {
-            // Handle global emit
-            const arr = this._listeners[event][id];
-            const arrCount = arr.length;
-            for (let arrIndex = 0; arrIndex < arrCount; arrIndex++) {
-                // Check we have a function to execute
-                const tmpFunc = arr[arrIndex];
-                if (typeof tmpFunc === "function") {
-                    tmpFunc.call(this, ...data);
-                }
-            }
-        }
-        this._emitting = false;
-        this._processRemovalQueue();
-        return this;
-    }
-    emitId(event, id, ...data) {
-        this._listeners = this._listeners || {};
-        this._emitting = true;
-        if (!this._listeners || !this._listeners[event]) {
-            this._emitting = false;
-            this._processRemovalQueue();
-            return this;
-        }
-        // Handle id emit
-        if (this._listeners[event][id]) {
-            const arr = this._listeners[event][id];
-            const arrCount = arr.length;
-            for (let arrIndex = 0; arrIndex < arrCount; arrIndex++) {
-                // Check we have a function to execute
-                const tmpFunc = arr[arrIndex];
-                if (typeof tmpFunc === "function") {
-                    tmpFunc.call(this, ...data);
-                }
-            }
-        }
-        // Handle global emit
-        if (this._listeners[event]["*"]) {
-            const arr = this._listeners[event]["*"];
-            const arrCount = arr.length;
-            for (let arrIndex = 0; arrIndex < arrCount; arrIndex++) {
-                // Check we have a function to execute
-                const tmpFunc = arr[arrIndex];
-                if (typeof tmpFunc === "function") {
-                    tmpFunc.call(this, ...data);
-                }
-            }
-        }
-        this._emitting = false;
-        this._processRemovalQueue();
-        return this;
-    }
-    /**
-     * Creates a static event emitter that is emitted whenever an
-     * event listener is created with the same name.
-     * @param {String} event The name of the event to emit.
-     * @param {*} data The data to emit with the event.
-     * @returns {Emitter} The emitter instance.
-     */
-    emitStatic(event, ...data) {
-        this._emitters = this._emitters || {};
-        this._emitters[event] = this._emitters[event] || [];
-        this._emitters[event].push({
-            "id": "*",
-            "args": data
-        });
-        this.emit(event, ...data);
-        this._processRemovalQueue();
-        return this;
-    }
-    /**
-     * Creates a static event emitter that is emitted whenever an
-     * event listener is created with the same name and id.
-     * @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 {Emitter} The emitter instance.
-     */
-    emitStaticId(event, id, ...data) {
-        if (!id)
-            throw new Error("Missing id from emitStaticId call!");
-        this._emitters = this._emitters || {};
-        this._emitters[event] = this._emitters[event] || [];
-        this._emitters[event].push({
-            id,
-            "args": data
-        });
-        this.emitId(event, id, ...data);
-        return this;
-    }
-    /**
-     * Handles removing emitters, is an internal method not called directly.
-     * @param {String} event The event to remove static emitter for.
-     * @returns {Emitter} The emitter instance.
-     * @private
-     */
-    cancelStatic(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(event) {
-        const id = "*";
-        if (!this._listeners || !this._listeners[event]) {
-            return false;
-        }
-        const arr = this._listeners[event][id];
-        const arrCount = arr.length;
-        for (let arrIndex = 0; arrIndex < 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.
-     * @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(event, id) {
-        if (!this._listeners || !this._listeners[event]) {
-            return false;
-        }
-        // Handle id emit
-        if (this._listeners[event][id]) {
-            const arr = this._listeners[event][id];
-            const arrCount = arr.length;
-            for (let arrIndex = 0; arrIndex < arrCount; arrIndex++) {
-                // Check we have a function to execute
-                const tmpFunc = arr[arrIndex];
-                if (typeof tmpFunc === "function") {
-                    return true;
-                }
-            }
-        }
-        // Handle global emit
-        if (this._listeners[event]["*"]) {
-            const arr = this._listeners[event]["*"];
-            const arrCount = arr.length;
-            for (let arrIndex = 0; arrIndex < 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 the same eventName. 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.
-     * @returns {Emitter} The emitter instance.
-     */
-    deferEmit(eventName, ...data) {
-        if (this._noEmitDefer) {
-            this.emit(eventName, ...data);
-            return this;
-        }
-        // Check for an existing timeout
-        this._deferTimeout = this._deferTimeout || {};
-        if (this._deferTimeout[eventName]) {
-            clearTimeout(this._deferTimeout[eventName]);
-        }
-        // Set a timeout
-        this._deferTimeout[eventName] = setTimeout(() => {
-            this.emit(eventName, ...data);
-        }, 100);
-        return this;
-    }
-    /**
-     * 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
-     * @returns {undefined}
-     */
-    _processRemovalQueue() {
-        if (!this._eventRemovalQueue || !this._eventRemovalQueue.length) {
-            return;
-        }
-        // Execute each removal call
-        for (let i = 0; i < this._eventRemovalQueue.length; i++) {
-            this._eventRemovalQueue[i]();
-        }
-        // Clear the removal queue
-        this._eventRemovalQueue = [];
-    }
-}
-exports.Emitter = Emitter;
-const makeEmitter = (obj, prototypeMode = false) => {
-    let operateOnObject;
-    if (obj === undefined && prototypeMode === undefined) {
-        obj = {};
-        prototypeMode = false;
-    }
-    if (typeof obj === "boolean" && prototypeMode === undefined) {
-        prototypeMode = obj;
-        obj = {};
-    }
-    if (prototypeMode === undefined) {
-        prototypeMode = false;
-    }
-    if (typeof obj !== "object" && typeof obj !== "function") {
-        throw new Error("Cannot operate on passed value, it is not an object, function or class!");
-    }
-    if (prototypeMode) {
-        if (obj.prototype === undefined) {
-            throw new Error("Cannot modify prototype of passed object, it has no prototype property!");
-        }
-        operateOnObject = obj.prototype;
-    }
-    else {
-        operateOnObject = obj;
-    }
-    // Convert the object to have eventing capability
-    operateOnObject.on = Emitter.prototype.on;
-    operateOnObject.off = Emitter.prototype.off;
-    operateOnObject.one = Emitter.prototype.one;
-    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;
-    operateOnObject._on = Emitter.prototype._on;
-    operateOnObject._off = Emitter.prototype._off;
-    operateOnObject._once = Emitter.prototype._once;
-    return obj;
-};
-exports.makeEmitter = makeEmitter;