From 3a0f76b7ad8e8c183c1cacf87437d0a33abcf122 Mon Sep 17 00:00:00 2001 From: "Vincent Yanzee J. Tan" Date: Fri, 21 Jun 2024 08:45:16 +0800 Subject: [PATCH] prepend op unused in EventManager.addEventListener --- src/catalyst/core/events.ts | 231 ++++++++++++++++++------------------ 1 file changed, 118 insertions(+), 113 deletions(-) diff --git a/src/catalyst/core/events.ts b/src/catalyst/core/events.ts index 8fcf955..12d883c 100644 --- a/src/catalyst/core/events.ts +++ b/src/catalyst/core/events.ts @@ -6,18 +6,18 @@ * event listener interface */ export interface eventListener { - /** - * name of event - */ - event: string, - /** - * the callback to execute - */ - callback: (...args: any) => void, - /** - * listen for event once - */ - once: boolean, + /** + * name of event + */ + event: string, + /** + * the callback to execute + */ + callback: (...args: any) => void, + /** + * listen for event once + */ + once: boolean, } /** @@ -25,105 +25,110 @@ export interface eventListener { * event manager class */ export class EventManager> { - /** - * event listeners - * @private - */ - private readonly _listeners: eventListener[] = []; - - /** - * registers an event listener - * @param event the name of event to listen for - * @param callback a function to call when the event is fired - * @param [once] listen for the event only once - * @param [prepend] make the listener in first priority to execute - * @returns the event listener object - */ - public addEventListener( - event: N, - callback: (...args: T[N]) => void, - once?: boolean, - prepend?: boolean - ): eventListener { - const listener = { - event: event as string, - callback, - once: !!once - }; - this._listeners.push(listener); - return listener; - } - - /** - * removes an event listener - * @param listener the listener to remove - * @returns true if succeded - */ - public removeEventListener(listener: eventListener): boolean { - const idx = this._listeners.indexOf(listener); - if (idx == -1) return false; - this._listeners.splice(idx, 1); - return true; - } - - /** - * fires an event - * @param event the name of event - * @param args[] the arguments to fire - * @returns number of listeners that is fired - */ - public dispatchEvent(event: N, ...args: T[N]): number { - // number of listeners ran - let n = 0; - - // iterate through the _listeners array - this._listeners.forEach(listener => { - // skip listener - if (listener.event != event) return; - // increment the counter - n++; - - // run the listener - try { - listener.callback?.(...args); - } catch (e) { - // error - let msg = `Uncaught exception on an event listener for ${event as string}:\n`; - msg += e; - if (e?.stack) msg += e.stack; - console.error(e); - } - - // the listener only listens once - if (listener.once) this.removeEventListener(listener); - }); - - return n; - } - - // some aliases for our methods: - - public on(event: N, callback: (...args: T[N]) => void): eventListener { - return this.addEventListener(event, callback, false, false); - } - - public once(event: N, callback: (...args: T[N]) => void): eventListener { - return this.addEventListener(event, callback, true, false); - } - - public prepend(event: N, callback: (...args: T[N]) => void): eventListener { - return this.addEventListener(event, callback, false, true); - } - - public prependOnce(event: N, callback: (...args: T[N]) => void): eventListener { - return this.addEventListener(event, callback, true, true); - } - - public off(listener: eventListener): boolean { - return this.removeEventListener(listener); - } - - public emit(event: N, ...args: T[N]): number { - return this.dispatchEvent(event, ...args); - } + /** + * event listeners + * @private + */ + private readonly _listeners: eventListener[] = []; + + /** + * registers an event listener + * @param event the name of event to listen for + * @param callback a function to call when the event is fired + * @param [once] listen for the event only once + * @param [prepend] make the listener in first priority to execute + * @returns the event listener object + */ + public addEventListener( + event: N, + callback: (...args: T[N]) => void, + once?: boolean, + prepend?: boolean + ): eventListener { + const listener = { + event: event as string, + callback, + once: !!once + }; + + // set the listener to queue + if (prepend) this._listeners.unshift(listener); + else this._listeners.push(listener); + + return listener; + } + + /** + * removes an event listener + * @param listener the listener to remove + * @returns true if succeded + */ + public removeEventListener(listener: eventListener): boolean { + const idx = this._listeners.indexOf(listener); + if (idx == -1) return false; + this._listeners.splice(idx, 1); + return true; + } + + /** + * fires an event + * @param event the name of event + * @param args[] the arguments to fire + * @returns number of listeners that is fired + */ + public dispatchEvent(event: N, ...args: T[N]): number { + // number of listeners ran + let n = 0; + + // iterate through the _listeners array + this._listeners.forEach(listener => { + // skip listener + if (listener.event != event) return; + // increment the counter + n++; + + // run the listener + try { + listener.callback?.(...args); + } catch (e) { + // error + let msg = `Uncaught exception on an event listener for ${event as string}:\n`; + msg += e; + if (e?.stack) msg += e.stack; + console.error(e); + } + + // the listener only listens once + if (listener.once) this.removeEventListener(listener); + }); + + return n; + } + + // some aliases for our methods: + + public on(event: N, callback: (...args: T[N]) => void): eventListener { + return this.addEventListener(event, callback, false, false); + } + + public once(event: N, callback: (...args: T[N]) => void): eventListener { + return this.addEventListener(event, callback, true, false); + } + + public prepend(event: N, callback: (...args: T[N]) => void): eventListener { + return this.addEventListener(event, callback, false, true); + } + + public prependOnce(event: N, callback: (...args: T[N]) => void): eventListener { + return this.addEventListener(event, callback, true, true); + } + + public off(listener: eventListener): boolean { + return this.removeEventListener(listener); + } + + public emit(event: N, ...args: T[N]): number { + return this.dispatchEvent(event, ...args); + } } +