@adrianbutt/evutils 1.0.0

package/dist/mjs/src/BasicEventManager.js

@@ -0,0 +1,225 @@
+export class BasicEventManager {
+    _safeMode;
+    _listeners;
+    _argProcessors;
+    _logger;
+    constructor() {
+        this._safeMode = true;
+        this._listeners = {};
+        this._argProcessors = {};
+    }
+    trigger(eventName) {
+        if (!eventName) {
+            return false;
+        }
+        if (!this._listeners[eventName]) {
+            return false;
+        }
+        let args;
+        // parse the args.
+        if (arguments.length < 2) {
+            // called like this 'trigger(eventName)'
+            args = [];
+        }
+        else {
+            args = arguments[1];
+        }
+        if (this._argProcessors[eventName]) {
+            let processedArgs;
+            try {
+                processedArgs = this._argProcessors[eventName].processor.apply(this._argProcessors[eventName].context, [eventName, args]);
+            }
+            catch (e) {
+                if (!this._safeMode) {
+                    throw e;
+                }
+                else if (this._logger) {
+                    this._logger.error(`Arg processor error for '${eventName}'`, e);
+                }
+                return false;
+            }
+            if (!processedArgs) {
+                // cancel
+                return false;
+            }
+            if (processedArgs === true) {
+                // use existing args
+            }
+            else if (!Array.isArray(processedArgs)) {
+                if (!this._safeMode) {
+                    throw `Invalid result '${processedArgs}' from arg processor for '${eventName}'`;
+                }
+                else if (this._logger) {
+                    this._logger.error(`Invalid result from arg processor for '${eventName}'`, processedArgs);
+                }
+                return false;
+            }
+            else {
+                args = processedArgs;
+            }
+        }
+        // get a copy of the array in case someone unregisters
+        let handlerArr = this._listeners[eventName].slice(0);
+        for (let i = 0; i < handlerArr.length; i++) {
+            let curHandlerMap = handlerArr[i];
+            // find out if we still have the listener registered
+            let stillRegistered = false;
+            let numListeners = this._listeners[eventName]
+                ? this._listeners[eventName].length
+                : 0;
+            for (let j = 0; j < numListeners; j++) {
+                if (curHandlerMap == this._listeners[eventName][j]) {
+                    stillRegistered = true;
+                    break;
+                }
+            }
+            // if we can call the method, do so.
+            if (stillRegistered) {
+                try {
+                    curHandlerMap.handler.apply(curHandlerMap.context, args);
+                }
+                catch (err) {
+                    if (!this._safeMode) {
+                        throw err;
+                    }
+                }
+            }
+        }
+        return true;
+    }
+    on(eventName, handler, context) {
+        if (!eventName) {
+            return false;
+        }
+        if (!handler) {
+            return false;
+        }
+        if (!this._listeners[eventName]) {
+            this._listeners[eventName] = [];
+        }
+        this._listeners[eventName].push({
+            handler,
+            context
+        });
+        return true;
+    }
+    off(eventName, handler, context) {
+        if (!eventName) {
+            return false;
+        }
+        if (!handler) {
+            return false;
+        }
+        const relListeners = this._listeners[eventName];
+        if (!relListeners) {
+            return false;
+        }
+        let fndIndex = -1;
+        for (let i = 0; i < relListeners.length; i++) {
+            if (relListeners[i].handler === handler &&
+                relListeners[i].context === context) {
+                fndIndex = i;
+                break;
+            }
+        }
+        if (fndIndex === -1) {
+            return false;
+        }
+        relListeners.splice(fndIndex, 1);
+        if (!relListeners.length) {
+            delete this._listeners[eventName];
+        }
+        return true;
+    }
+    register(toState, eventName, handler, context) {
+        if (arguments.length > 3) {
+            return this[toState ? "on" : "off"](eventName, handler, context);
+        }
+        else {
+            return this[toState ? "on" : "off"](eventName, handler);
+        }
+    }
+    hasCustomArgumentProcessor(eventName) {
+        return !!this._argProcessors[eventName];
+    }
+    setCustomArgumentProcessor(eventName, processor, context) {
+        if (!eventName) {
+            return false;
+        }
+        if (!processor) {
+            if (this.hasCustomArgumentProcessor(eventName)) {
+                delete this._argProcessors[eventName];
+                return true;
+            }
+            return false;
+        }
+        this._argProcessors[eventName] = {
+            processor: processor,
+            context: context
+        };
+        return true;
+    }
+    get ignoreErrors() {
+        return this._safeMode;
+    }
+    set ignoreErrors(v) {
+        this._safeMode = !!v;
+    }
+    get logger() {
+        return this._logger ?? null;
+    }
+    set logger(v) {
+        if (v) {
+            this._logger = v;
+        }
+        else {
+            delete this._logger;
+        }
+    }
+}
+/**
+ * Utility class that allows for simple setup of event registration,
+ * whilst keeping triggering hidden.
+ */
+export class BasicEventPublisher {
+    _evManager;
+    constructor(evManager) {
+        this._evManager = evManager ?? new BasicEventManager();
+        this.on = this._evManager.on.bind(this._evManager);
+        this.off = this._evManager.off.bind(this._evManager);
+        this.register = this._evManager.register.bind(this._evManager);
+        this._trigger = this._evManager.trigger.bind(this._evManager);
+    }
+    on;
+    off;
+    register;
+    _trigger;
+}
+export function mixinEventPublisherUsingManager(ontoObject, usingManager) {
+    // // example usage:
+    // type MyEventMap = {
+    //   myevent: (eventCode: number, label: string) => void;
+    // };
+    // interface MyEventPublisher extends IBasicEventPublisher<MyEventMap> {}
+    // class MyEventPublisher {
+    //   private _evManager: BasicEventManager<MyEventMap>;
+    //   constructor() {
+    //     this._evManager = new BasicEventManager<MyEventMap>();
+    //     mixinEventPublisherUsingManager<MyEventMap>(this, this._evManager);
+    //   }
+    //   sendMyEvent(eventCode: number, label: string) {
+    //     this._evManager.trigger("myevent", [eventCode, label]);
+    //   }
+    // }
+    let mixinProps = {
+        on: usingManager.on.bind(usingManager),
+        off: usingManager.off.bind(usingManager),
+        register: usingManager.register.bind(usingManager)
+    };
+    for (let key in mixinProps) {
+        ontoObject[key] =
+            mixinProps[key];
+    }
+}
+export default BasicEventManager;
+//# sourceMappingURL=BasicEventManager.js.map

package/dist/mjs/src/BasicEventManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BasicEventManager.js","sourceRoot":"","sources":["../../../src/BasicEventManager.ts"],"names":[],"mappings":"AA8GA,MAAM,OAAO,iBAAiB;IAGpB,SAAS,CAAU;IACnB,UAAU,CAAgC;IAC1C,cAAc,CAAuC;IACrD,OAAO,CAAU;IAEzB;QACE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;IAC3B,CAAC;IAMD,OAAO,CAAC,SAAiB;QACvB,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAe,CAAC;QAEpB,kBAAkB;QAClB,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,wCAAwC;YACxC,IAAI,GAAG,EAAE,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QACtB,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;YACnC,IAAI,aAA+D,CAAC;YAEpE,IAAI,CAAC;gBACH,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,KAAK,CAC5D,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,OAAO,EACtC,CAAC,SAAS,EAAE,IAAI,CAAC,CAClB,CAAC;YACJ,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;oBACpB,MAAM,CAAC,CAAC;gBACV,CAAC;qBAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBACxB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,4BAA4B,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC;gBAClE,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,SAAS;gBACT,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;gBAC3B,oBAAoB;YACtB,CAAC;iBAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;gBACzC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;oBACpB,MAAM,mBAAmB,aAAa,6BAA6B,SAAS,GAAG,CAAC;gBAClF,CAAC;qBAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBACxB,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,0CAA0C,SAAS,GAAG,EACtD,aAAa,CACd,CAAC;gBACJ,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,aAAa,CAAC;YACvB,CAAC;QACH,CAAC;QAED,sDAAsD;QACtD,IAAI,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACrD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,IAAI,aAAa,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;YAElC,oDAAoD;YACpD,IAAI,eAAe,GAAG,KAAK,CAAC;YAE5B,IAAI,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;gBAC3C,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM;gBACnC,CAAC,CAAC,CAAC,CAAC;YAEN,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtC,IAAI,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBACnD,eAAe,GAAG,IAAI,CAAC;oBACvB,MAAM;gBACR,CAAC;YACH,CAAC;YAED,oCAAoC;YACpC,IAAI,eAAe,EAAE,CAAC;gBACpB,IAAI,CAAC;oBACH,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;gBAC3D,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;wBACpB,MAAM,GAAG,CAAC;oBACZ,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,EAAE,CACA,SAAY,EACZ,OAAqB,EACrB,OAA6B;QAE7B,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;QAClC,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC;YAC9B,OAAO;YACP,OAAO;SACR,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IACD,GAAG,CACD,SAAY,EACZ,OAAqB,EACrB,OAA6B;QAE7B,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAC;QAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7C,IACE,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO;gBACnC,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,EACnC,CAAC;gBACD,QAAQ,GAAG,CAAC,CAAC;gBACb,MAAM;YACR,CAAC;QACH,CAAC;QAED,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE,CAAC;YACpB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QAEjC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IACD,QAAQ,CACN,OAAgB,EAChB,SAAY,EACZ,OAAqB,EACrB,OAA6B;QAE7B,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACnE,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED,0BAA0B,CAAC,SAAiB;QAC1C,OAAO,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IAC1C,CAAC;IACD,0BAA0B,CACxB,SAAiB,EACjB,SAA4D,EAC5D,OAA6B;QAE7B,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,IAAI,IAAI,CAAC,0BAA0B,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC/C,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;gBACtC,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,GAAG;YAC/B,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,OAAO;SACjB,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD,IAAI,YAAY,CAAC,CAAU;QACzB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IACD,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;IAC9B,CAAC;IACD,IAAI,MAAM,CAAC,CAAgB;QACzB,IAAI,CAAC,EAAE,CAAC;YACN,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,mBAAmB;IAG7B,UAAU,CAAgC;IAEpD,YAAY,SAAyC;QACnD,IAAI,CAAC,UAAU,GAAG,SAAS,IAAI,IAAI,iBAAiB,EAAa,CAAC;QAElE,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAChE,CAAC;IAED,EAAE,CAAsC;IACxC,GAAG,CAAuC;IAC1C,QAAQ,CAA4C;IAE1C,QAAQ,CAA2C;CAC9D;AAED,MAAM,UAAU,+BAA+B,CAG7C,UAA2C,EAC3C,YAA2C;IAE3C,oBAAoB;IACpB,sBAAsB;IACtB,yDAAyD;IACzD,KAAK;IACL,yEAAyE;IACzE,2BAA2B;IAC3B,uDAAuD;IACvD,oBAAoB;IACpB,6DAA6D;IAC7D,0EAA0E;IAC1E,MAAM;IACN,oDAAoD;IACpD,8DAA8D;IAC9D,MAAM;IACN,IAAI;IAKJ,IAAI,UAAU,GAAsB;QAClC,EAAE,EAAE,YAAY,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;QACtC,GAAG,EAAE,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC;QACxC,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC;KACnD,CAAC;IAEF,KAAK,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;QAC1B,UAAiD,CAAC,GAAG,CAAC;YACrD,UAAU,CAAC,GAA8B,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC;AAED,eAAe,iBAAiB,CAAC"}

package/dist/mjs/src/index.d.ts

@@ -0,0 +1 @@
+export { BasicEventManager } from "./BasicEventManager.js";

package/dist/mjs/src/index.js

@@ -0,0 +1,2 @@
+export { BasicEventManager } from "./BasicEventManager.js";
+//# sourceMappingURL=index.js.map

package/dist/mjs/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/mjs/src/mapped/EvForwarder.d.ts

@@ -0,0 +1,265 @@
+import type { IBasicEventPublisher, DefaultEventMap, EventHandlerContext, EventMapDef } from "../../src/BasicEventManager.js";
+/**
+ * Event param conditions
+ * <br> If a string, will be parsed and converted into an EvParamCondition
+ * @example
+ * ```ts
+ * // would check if the param at index 1 does exist (ie arguments >= 2 in length)
+ * '1'
+ * // would check if the param at index 1 does not exist (ie arguments < 2 in length)
+ * '1!'
+ * // would check if the param at index 1 IS 'Monday'
+ * '1="Monday"'
+ * '1="Monday" i' // (case insensitive)
+ * // would check if the param at index 1 is NOT 'Monday'
+ * '1!="Monday"'
+ * '1!="Monday" i' // (case insensitive)
+ * // would check if the param at index 1 starts with 'Mon'
+ * '1^="Mon"'
+ * '1^="Mon" i' // (case insensitive)
+ * // would check if the param at index 1 ends with 'day'
+ * '1$="day"'
+ * '1$="day" i' // (case insensitive)
+ * // would check if the param at index 1 contains the string 'day'
+ * '1*="day"'
+ * '1*="day" i' // (case insensitive)
+ * // would check if the param at index 1 was equal to 'Monday' or 'Tuesday'
+ * '1~="Monday Tuesday"'
+ * '1~="Monday Tuesday" i' // (case insensitive)
+ * ```
+ */
+export type EvParamConditionLike = EvParamCondition | string;
+/**
+ * Event parameter forwarding instructions
+ * <br> If a string, will be parsed and converted into an EvParamCondition
+ * @example
+ * ```ts
+ * // No parameters should be forwarded
+ * '!'
+ *
+ * '1'      // -> { from: 1,     to: 1                        }
+ * '2+'     // -> { from: 2,     to: Number.POSITIVE_INFINITY }
+ * '2-'     // -> { from: 2,     to: Number.NEGATIVE_INFINITY }
+ * '6-7'    // -> { from: 6,     to: 7                        }
+ * ```
+ */
+export type EvParamForwardInstructionLike = EvParamForwardInstruction | string;
+/**
+ * Essentially an {@link EvForwarderMap} with the option to specify strings as param properties
+ */
+export type EvForwarderConstructorEventMap = {
+    eventName: string;
+    forwardedEventName?: string;
+    paramConditions: EvParamConditionLike[];
+    paramForwardInstructions: EvParamForwardInstructionLike[];
+};
+/**
+ * Options to create an EvForwarder
+ * @property eventReceiver - the original or 'root' event broadcaster
+ * @property eventMaps - event forwarding instructions
+ * @property autoEnable - whether the forwarder should automatically connect to the eventReceiver
+ */
+export type EvForwarderConstructorOptions = {
+    eventReceiver: IBasicEventPublisher;
+    eventMaps: EvForwarderConstructorEventMap[];
+    autoEnable?: boolean;
+};
+/**
+ * Event forwarding instructions
+ * @property eventName - original event name
+ * @property forwardedEventName - the forwarded event name
+ *                                (if not provided, the original event name will be used)
+ * @property paramConditions - parameter conditions that the original event must clear
+ * @property paramForwardInstructions - how the original event's parameters should be forwarded.
+ *                                      (All will be forwarded if not present)
+ */
+export type EvForwarderMap = {
+    eventName: string;
+    forwardedEventName?: string;
+    paramConditions: EvParamCondition[];
+    paramForwardInstructions: EvParamForwardInstruction[];
+};
+/**
+ * Used to verify event params
+ * @property index - relevant zero-based parameter index
+ * @property operator - condition operator to run
+ * @property comparison - strings to compare with
+ * @property caseSensitive - whether the comparison should be case sensitive
+ *
+ */
+export type EvParamCondition = {
+    index: number;
+    operator: EvParamOperator;
+    comparison: string[];
+    caseSensitive: boolean;
+};
+/**
+ * Used to define what params should be forwarded in an event.
+ * <br><br>If both "from" and "to" are NaN -> no parameters should be forwarded
+ * <br><br>If both "from" or "to" are less than 0 -> the index is assumed to be an offset from params length
+ * @property from - start index
+ * @property to - end index
+ */
+export type EvParamForwardInstruction = {
+    from: number;
+    to: number;
+};
+/**
+ * Operator for param verification.
+ * @sortStrategy source-order
+ */
+export declare enum EvParamOperator {
+    /**
+     * Whether the parameter does not exist.
+     * <br> NOTE: No suffix is expected after using EXISTS.
+     * @example
+     * ```ts
+     * // would check if the param at index 1 does exist (ie arguments >= 2 in length)
+     * '1_'
+     * // is functionally equivalent to having NO operator
+     * '1'
+     * ```
+     */
+    EXISTS = "_",
+    /**
+     * Whether the parameter does not exist.
+     * <br> NOTE: No suffix is expected after using NOT_EXISTS.
+     * @example
+     * ```ts
+     * // would check if the param at index 1 does not exist (ie arguments < 2 in length)
+     * '1!'
+     * ```
+     */
+    NOT_EXISTS = "!",
+    /**
+     * Whether the value is equal to a string
+     * @example
+     * ```ts
+     * // would check if the param at index 1 IS 'monday'
+     * '1="monday"'
+     * ```
+     */
+    EQUAL = "=",
+    /**
+     * Whether the value is not equal to a string
+     * @example
+     * ```ts
+     * // would check if the param at index 1 is NOT 'monday'
+     * '1!="monday"'
+     * ```
+     */
+    NOT_EQUAL = "!=",
+    /**
+     * Whether the value ends with a string
+     * @example
+     * ```ts
+     * // would check if the param at index 1 starts with 'mon'
+     * '1^="mon"'
+     * ```
+     */
+    STARTS_WITH = "^=",
+    /**
+     * Whether the value ends with a string
+     * @example
+     * ```ts
+     * // would check if the param at index 1 ends with 'day'
+     * '1$="day"'
+     * ```
+     */
+    ENDS_WITH = "$=",
+    /**
+     * Whether the value contains a string
+     * @example
+     * ```ts
+     * // would check if the param at index 1 contains the string 'day'
+     * '1*="day"'
+     * ```
+     */
+    CONTAINS = "*=",
+    /**
+     * Exact match for space separated words
+     * @example
+     * ```ts
+     * // would check if the param at index 1 was equal to 'monday' or 'tuesday'
+     * '1~="monday tuesday"'
+     * ```
+     */
+    MATCHES_WORD = "~="
+}
+/**
+ * Event forwarder
+ *
+ * @example
+ * ```ts
+ * const rootEvMgr = new BasicEventManager();
+ * const evFwder = new EvForwarder({
+ *   eventReceiver: rootEvMgr,
+ *   eventMaps: [{
+ *     eventName: "FoodEvent",
+ *     paramConditions: [],
+ *     paramForwardInstructions: []
+ *   }, {
+ *     eventName: "FoodEvent",
+ *     forwardedEventName: "AteFood",
+ *     paramConditions: ['0="Ate"'],
+ *     paramForwardInstructions: ["2"]
+ *   }, {
+ *     eventName: "FoodEvent",
+ *     forwardedEventName: "AteSnack",
+ *     paramConditions: ['0="Ate"', '1="Snack"'],
+ *     paramForwardInstructions: ["2"]
+ *   }],
+ *   autoEnable: true
+ * });
+ *
+ * const handleFoodEvent = function () {};
+ * const handleAteFood = function () {};
+ * const handleAteSnack = function () {};
+ * evFwder.on("FoodEvent", handleFoodEvent);
+ * evFwder.on("AteFood", handleAteFood);
+ * evFwder.on("AteSnack", handleAteSnack);
+ *
+ * rootEvMgr.trigger("FoodEvent", []);
+ * rootEvMgr.trigger("FoodEvent", ["Ate", "Snack", "Chocolate"]);
+ * rootEvMgr.trigger("FoodEvent", ["Ate", "Snack", "Biscuit"]);
+ * rootEvMgr.trigger("FoodEvent", ["Ate", "Meal", "Sandwich"]);
+ * rootEvMgr.trigger("FoodEvent", ["Drank", "Soft", "Lemonade"]);
+ * rootEvMgr.trigger("FoodEvent", ["Drank", "Hard", "Vodka"]);
+ *
+ * // handleFoodEvent invocations:
+ * //   handleFoodEvent();
+ * //   handleFoodEvent("Ate", "Snack", "Chocolate");
+ * //   handleFoodEvent("Ate", "Snack", "Biscuit");
+ * //   handleFoodEvent("Ate", "Meal", "Sandwich");
+ * //   handleFoodEvent("Drank", "Soft", "Lemonade");
+ * //   handleFoodEvent("Drank", "Hard", "Vodka");
+ *
+ * // handleAteFood invocations:
+ * //   handleAteFood("Chocolate");
+ * //   handleAteFood("Biscuit");
+ * //   handleAteFood("Sandwich");
+ *
+ * // handleAteSnack invocations:
+ * //   handleAteSnack("Chocolate");
+ * //   handleAteSnack("Biscuit");
+ * ```
+ */
+export declare class EvForwarder<TEventMap extends EventMapDef<TEventMap> = DefaultEventMap> implements IBasicEventPublisher<TEventMap> {
+    private _evReceiver;
+    private _evMgr;
+    private _evMaps;
+    private _active?;
+    constructor(options: EvForwarderConstructorOptions);
+    /**
+     * Whether the forwarder should forward events or not.
+     */
+    get active(): boolean;
+    /**
+     * Whether the forwarder should forward events or not.
+     */
+    set active(to: boolean);
+    on<T extends keyof TEventMap & string>(eventName: T, handler: TEventMap[T], context?: EventHandlerContext): boolean;
+    off<T extends keyof TEventMap & string>(eventName: T, handler: TEventMap[T], context?: EventHandlerContext): boolean;
+    register<T extends keyof TEventMap & string>(toState: boolean, eventName: T, handler: TEventMap[T], context?: EventHandlerContext): boolean;
+    private _refreshListeners;
+}