@anephenix/event-emitter 0.0.13 → 0.0.14

package/README.md

@@ -108,6 +108,20 @@ emitter.emit("join", "Alice");
 This will help with preventing the misspelling of event names and also ensuring 
 that the event data payloads are correct.
 
+## Applying multiple event names for the same listener
+
+If you find that you have multiple event names calling the same function, and 
+you would like to DRY up your code a bit, you can pass the event names in an 
+array to the `on` function like this:
+
+```typescript
+emitter.on(['user-join', 'bot-join'], (username:string) => {
+    console.log(`${username} joined`);
+});
+```
+
+It also works for `off` calls as well.
+
 ## Tests
 
 You can run the unit tests using this command:

package/dist/EventEmitter.d.ts

@@ -5,8 +5,8 @@ declare class EventEmitter<T extends EventMap> {
     };
     enableLogging: boolean;
     log(...args: unknown[]): void;
-    on<K extends keyof T>(event: K, listener: T[K]): void;
-    off<K extends keyof T>(event: K, listener: T[K]): void;
+    on<K extends keyof T>(event: K | K[], listener: T[K]): void;
+    off<K extends keyof T>(event: K | K[], listener: T[K]): void;
     emit<K extends keyof T>(event: K, ...args: Parameters<T[K]>): void;
 }
 export default EventEmitter;

package/dist/EventEmitter.js

@@ -9,12 +9,24 @@ class EventEmitter {
         }
     }
     on(event, listener) {
+        if (Array.isArray(event)) {
+            for (const ev of event) {
+                this.on(ev, listener);
+            }
+            return;
+        }
         if (!this.events[event]) {
             this.events[event] = [];
         }
         this.events[event].push(listener);
     }
     off(event, listener) {
+        if (Array.isArray(event)) {
+            for (const ev of event) {
+                this.off(ev, listener);
+            }
+            return;
+        }
         const listeners = this.events[event];
         if (!listeners)
             return;

package/dist/EventEmitter.js.map

@@ -1 +1 @@
-{"version":3,"file":"EventEmitter.js","sourceRoot":"","sources":["../src/EventEmitter.ts"],"names":[],"mappings":"AAGA,MAAM,YAAY;IAAlB;QACC,WAAM,GAAgC,EAAE,CAAC;QACzC,kBAAa,GAAG,KAAK,CAAC;IA6BvB,CAAC;IA3BA,GAAG,CAAC,GAAG,IAAe;QACrB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;QACtB,CAAC;IACF,CAAC;IAED,EAAE,CAAoB,KAAQ,EAAE,QAAc;QAC7C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QACzB,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,GAAG,CAAoB,KAAQ,EAAE,QAAc;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS;YAAE,OAAO;QACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,CAAoB,KAAQ,EAAE,GAAG,IAAsB;QAC1D,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1D,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS;YAAE,OAAO;QACvB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YAClC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QACnB,CAAC;IACF,CAAC;CACD;AAED,eAAe,YAAY,CAAC"}
+{"version":3,"file":"EventEmitter.js","sourceRoot":"","sources":["../src/EventEmitter.ts"],"names":[],"mappings":"AAGA,MAAM,YAAY;IAAlB;QACC,WAAM,GAAgC,EAAE,CAAC;QACzC,kBAAa,GAAG,KAAK,CAAC;IAyCvB,CAAC;IAvCA,GAAG,CAAC,GAAG,IAAe;QACrB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;QACtB,CAAC;IACF,CAAC;IAED,EAAE,CAAoB,KAAc,EAAE,QAAc;QACnD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,KAAK,MAAM,EAAE,IAAI,KAAK,EAAE,CAAC;gBACxB,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;YACvB,CAAC;YACD,OAAO;QACR,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QACzB,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,GAAG,CAAoB,KAAc,EAAE,QAAc;QACpD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,KAAK,MAAM,EAAE,IAAI,KAAK,EAAE,CAAC;gBACxB,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;YACxB,CAAC;YACD,OAAO;QACR,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS;YAAE,OAAO;QACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,CAAoB,KAAQ,EAAE,GAAG,IAAsB;QAC1D,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1D,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS;YAAE,OAAO;QACvB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YAClC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QACnB,CAAC;IACF,CAAC;CACD;AAED,eAAe,YAAY,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@anephenix/event-emitter",
-	"version": "0.0.13",
+	"version": "0.0.14",
 	"description": "A small EventEmitter library",
 	"author": "Paul Jensen <paul@anephenix.com>",
 	"maintainers": [
@@ -32,7 +32,7 @@
 	},
 	"files": [
 		"dist",
-		"src"
+		"README.md"
 	],
 	"scripts": {
 		"build": "tsc --project tsconfig.json",

package/src/EventEmitter.ts

@@ -1,37 +0,0 @@
-// Generic type for an event map where each key has a listener signature
-export type EventMap = Record<string, (...args: unknown[]) => void>;
-
-class EventEmitter<T extends EventMap> {
-	events: { [K in keyof T]?: T[K][] } = {};
-	enableLogging = false;
-
-	log(...args: unknown[]) {
-		if (this.enableLogging) {
-			console.log(...args);
-		}
-	}
-
-	on<K extends keyof T>(event: K, listener: T[K]): void {
-		if (!this.events[event]) {
-			this.events[event] = [];
-		}
-		this.events[event].push(listener);
-	}
-
-	off<K extends keyof T>(event: K, listener: T[K]): void {
-		const listeners = this.events[event];
-		if (!listeners) return;
-		this.events[event] = listeners.filter((l) => l !== listener);
-	}
-
-	emit<K extends keyof T>(event: K, ...args: Parameters<T[K]>): void {
-		this.log("Emitting event:", event, "with args:", ...args);
-		const listeners = this.events[event];
-		if (!listeners) return;
-		for (const listener of listeners) {
-			listener(...args);
-		}
-	}
-}
-
-export default EventEmitter;

package/src/index.ts

@@ -1,2 +0,0 @@
-export type { EventMap } from "./EventEmitter.js";
-export { default } from "./EventEmitter.js";