@wxn0brp/event-emitter 0.0.2 → 0.0.4

package/README.md

@@ -1,6 +1,6 @@
 # @wxn0brp/event-emitter
 
-A simple event emitter.
+A simple event emitter with optional TypeScript support.
 
 ## Installation
 
@@ -10,6 +10,8 @@ npm install @wxn0brp/event-emitter
 
 ## Usage
 
+### Basic Usage (without types)
+
 ```typescript
 import { EventEmitter } from '@wxn0brp/event-emitter';
 
@@ -22,8 +24,44 @@ emitter.on('hello', (name) => {
 emitter.emit('hello', 'world');
 ```
 
+### Type-Safe Usage (optional)
+
+```typescript
+import { EventEmitter } from '@wxn0brp/event-emitter';
+
+// Define event types (optional - just for developer convenience)
+type MyEvents = {
+  hello: (name: string) => void;
+  data: (value: number, timestamp: Date) => void;
+  error: (message: string, code: number) => void;
+};
+
+// Create emitter with optional type hints
+const emitter = new EventEmitter<MyEvents>();
+
+// The types provide helpful hints during development
+emitter.on('hello', (name) => {
+  console.log(`Hello, ${name}!`); // 'name' is suggested as string
+});
+
+emitter.on('data', (value, timestamp) => {
+  console.log(`Value: ${value} at ${timestamp}`); // 'value' and 'timestamp' have type hints
+});
+
+// Emit events with type hints
+emitter.emit('hello', 'world'); // Typescript suggests string parameter
+emitter.emit('data', 42, new Date()); // Typescript suggests number and Date parameters
+
+// You can still emit events without strict type checking
+emitter.emit('unknown_event', 'any', 'data'); // This is still allowed at runtime
+```
+
 ## API
 
+### `EventEmitter<T = {}>`
+
+Generic event emitter class where `T` is an optional event map type for developer convenience. The type parameter is completely optional and provides type hints during development.
+
 ### `on(event: string, listener: Function): void`
 
 Registers an event listener.

package/dist/index.d.ts

@@ -1,36 +1,41 @@
-export declare class VEE {
+export type EventMap = {
+    [event: string]: (...args: any[]) => void;
+};
+export type EventName<T extends EventMap> = keyof T | (string & {});
+export type EventArgs<T extends EventMap, K extends EventName<T>> = K extends keyof T ? Parameters<T[K]> : any[];
+export declare class VEE<T extends EventMap = {}> {
     _events: {
         [event: string]: Function[];
     };
     /**
      * Registers an event listener
-     * @param {string} event - event name
+     * @param {K} event - event name
      * @param {Function} listener - function to be called when event occurs
      */
-    on(event: string, listener: Function): void;
+    on<K extends EventName<T>>(event: K, listener: (...args: EventArgs<T, K>) => void): void;
     /**
      * Registers a one-time event listener
-     * @param {string} event - event name
+     * @param {K} event - event name
      * @param {Function} listener - function to be called once
      */
-    once(event: string, listener: Function): void;
+    once<K extends EventName<T>>(event: K, listener: (...args: EventArgs<T, K>) => void): void;
     /**
      * Removes an event listener.
-     * @param {string} event - event name
+     * @param {K} event - event name
      * @param {Function} listener - listener to remove
      */
-    off(event: string, listener: Function): void;
+    off<K extends EventName<T>>(event: K, listener: (...args: EventArgs<T, K>) => void): void;
     /**
      * Emits an event
-     * @param {string} event - event name
-     * @param {...any} args - arguments to be passed to listeners
+     * @param {K} event - event name
+     * @param {...EventArgs<T, K>} args - arguments to be passed to listeners
      */
-    emit(event: string, ...args: any[]): void;
+    emit<K extends EventName<T>>(event: K, ...args: EventArgs<T, K>): void;
     /**
      * Returns the number of listeners for the given event
-     * @param {string} event - event name
+     * @param {K} event - event name
      */
-    listenerCount(event: string): number;
+    listenerCount<K extends EventName<T>>(event: K): number;
 }
 export default VEE;
 export { VEE as EventEmitter };

package/dist/index.js

@@ -2,17 +2,18 @@ export class VEE {
     _events = {};
     /**
      * Registers an event listener
-     * @param {string} event - event name
+     * @param {K} event - event name
      * @param {Function} listener - function to be called when event occurs
      */
     on(event, listener) {
-        if (!this._events[event])
-            this._events[event] = [];
-        this._events[event].push(listener);
+        const _event = event;
+        if (!this._events[_event])
+            this._events[_event] = [];
+        this._events[_event].push(listener);
     }
     /**
      * Registers a one-time event listener
-     * @param {string} event - event name
+     * @param {K} event - event name
      * @param {Function} listener - function to be called once
      */
     once(event, listener) {
@@ -24,18 +25,19 @@ export class VEE {
     }
     /**
      * Removes an event listener.
-     * @param {string} event - event name
+     * @param {K} event - event name
      * @param {Function} listener - listener to remove
      */
     off(event, listener) {
-        if (!this._events[event])
+        const _event = event;
+        if (!this._events[_event])
             return;
-        this._events[event] = this._events[event].filter(l => l !== listener);
+        this._events[_event] = this._events[_event].filter(l => l !== listener);
     }
     /**
      * Emits an event
-     * @param {string} event - event name
-     * @param {...any} args - arguments to be passed to listeners
+     * @param {K} event - event name
+     * @param {...EventArgs<T, K>} args - arguments to be passed to listeners
      */
     emit(event, ...args) {
         const listeners = this._events[event];
@@ -47,7 +49,7 @@ export class VEE {
     }
     /**
      * Returns the number of listeners for the given event
-     * @param {string} event - event name
+     * @param {K} event - event name
      */
     listenerCount(event) {
         return this._events[event]?.length || 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/event-emitter",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "wxn0brP",
@@ -30,4 +30,4 @@
       "default": "./dist/*.js"
     }
   }
-}
+}