hookified 1.4.0 → 1.5.1

package/dist/node/index.js

@@ -6,6 +6,12 @@ var Eventified = class {
     this._eventListeners = /* @__PURE__ */ new Map();
     this._maxListeners = 100;
   }
+  /**
+   * Adds a handler function for a specific event that will run only once
+   * @param {string | symbol} eventName
+   * @param {EventListener} listener
+   * @returns {IEventEmitter} returns the instance of the class for chaining
+   */
   once(eventName, listener) {
     const onceListener = (...arguments_) => {
       this.off(eventName, onceListener);
@@ -14,6 +20,11 @@ var Eventified = class {
     this.on(eventName, onceListener);
     return this;
   }
+  /**
+   * Gets the number of listeners for a specific event. If no event is provided, it returns the total number of listeners
+   * @param {string} eventName The event name. Not required
+   * @returns {number} The number of listeners
+   */
   listenerCount(eventName) {
     if (!eventName) {
       return this.getAllListeners().length;
@@ -21,21 +32,42 @@ var Eventified = class {
     const listeners = this._eventListeners.get(eventName);
     return listeners ? listeners.length : 0;
   }
+  /**
+   * Gets an array of event names
+   * @returns {Array<string | symbol>} An array of event names
+   */
   eventNames() {
     return Array.from(this._eventListeners.keys());
   }
-  rawListeners(eventName) {
-    if (!eventName) {
+  /**
+   * Gets an array of listeners for a specific event. If no event is provided, it returns all listeners
+   * @param {string} [event] (Optional) The event name
+   * @returns {EventListener[]} An array of listeners
+   */
+  rawListeners(event) {
+    if (!event) {
       return this.getAllListeners();
     }
-    return this._eventListeners.get(eventName) ?? [];
+    return this._eventListeners.get(event) ?? [];
   }
+  /**
+   * Prepends a listener to the beginning of the listeners array for the specified event
+   * @param {string | symbol} eventName
+   * @param {EventListener} listener
+   * @returns {IEventEmitter} returns the instance of the class for chaining
+   */
   prependListener(eventName, listener) {
     const listeners = this._eventListeners.get(eventName) ?? [];
     listeners.unshift(listener);
     this._eventListeners.set(eventName, listeners);
     return this;
   }
+  /**
+   * Prepends a one-time listener to the beginning of the listeners array for the specified event
+   * @param {string | symbol} eventName
+   * @param {EventListener} listener
+   * @returns {IEventEmitter} returns the instance of the class for chaining
+   */
   prependOnceListener(eventName, listener) {
     const onceListener = (...arguments_) => {
       this.off(eventName, onceListener);
@@ -44,14 +76,29 @@ var Eventified = class {
     this.prependListener(eventName, onceListener);
     return this;
   }
+  /**
+   * Gets the maximum number of listeners that can be added for a single event
+   * @returns {number} The maximum number of listeners
+   */
   maxListeners() {
     return this._maxListeners;
   }
-  // Add an event listener
+  /**
+   * Adds a listener for a specific event. It is an alias for the on() method
+   * @param {string | symbol} event
+   * @param {EventListener} listener
+   * @returns {IEventEmitter} returns the instance of the class for chaining
+   */
   addListener(event, listener) {
     this.on(event, listener);
     return this;
   }
+  /**
+   * Adds a listener for a specific event
+   * @param {string | symbol} event
+   * @param {EventListener} listener
+   * @returns {IEventEmitter} returns the instance of the class for chaining
+   */
   on(event, listener) {
     if (!this._eventListeners.has(event)) {
       this._eventListeners.set(event, []);
@@ -65,11 +112,22 @@ var Eventified = class {
     }
     return this;
   }
-  // Remove an event listener
+  /**
+   * Removes a listener for a specific event. It is an alias for the off() method
+   * @param {string | symbol} event
+   * @param {EventListener} listener
+   * @returns {IEventEmitter} returns the instance of the class for chaining
+   */
   removeListener(event, listener) {
     this.off(event, listener);
     return this;
   }
+  /**
+   * Removes a listener for a specific event
+   * @param {string | symbol} event
+   * @param {EventListener} listener
+   * @returns {IEventEmitter} returns the instance of the class for chaining
+   */
   off(event, listener) {
     const listeners = this._eventListeners.get(event) ?? [];
     const index = listeners.indexOf(listener);
@@ -81,21 +139,36 @@ var Eventified = class {
     }
     return this;
   }
-  // Emit an event
+  /**
+   * Calls all listeners for a specific event
+   * @param {string | symbol} event
+   * @param arguments_ The arguments to pass to the listeners
+   * @returns {boolean} Returns true if the event had listeners, false otherwise
+   */
   emit(event, ...arguments_) {
+    let result = false;
     const listeners = this._eventListeners.get(event);
     if (listeners && listeners.length > 0) {
       for (const listener of listeners) {
         listener(...arguments_);
+        result = true;
       }
     }
-    return true;
+    return result;
   }
-  // Get all listeners for a specific event
+  /**
+   * Gets all listeners for a specific event. If no event is provided, it returns all listeners
+   * @param {string} [event] (Optional) The event name
+   * @returns {EventListener[]} An array of listeners
+   */
   listeners(event) {
     return this._eventListeners.get(event) ?? [];
   }
-  // Remove all listeners for a specific event
+  /**
+   * Removes all listeners for a specific event. If no event is provided, it removes all listeners
+   * @param {string} [event] (Optional) The event name
+   * @returns {IEventEmitter} returns the instance of the class for chaining
+   */
   removeAllListeners(event) {
     if (event) {
       this._eventListeners.delete(event);
@@ -104,7 +177,11 @@ var Eventified = class {
     }
     return this;
   }
-  // Set the maximum number of listeners for a single event
+  /**
+   * Sets the maximum number of listeners that can be added for a single event
+   * @param {number} n The maximum number of listeners
+   * @returns {void}
+   */
   setMaxListeners(n) {
     this._maxListeners = n;
     for (const listeners of this._eventListeners.values()) {
@@ -113,6 +190,10 @@ var Eventified = class {
       }
     }
   }
+  /**
+   * Gets all listeners
+   * @returns {EventListener[]} An array of listeners
+   */
   getAllListeners() {
     let result = new Array();
     for (const listeners of this._eventListeners.values()) {
@@ -129,7 +210,12 @@ var Hookified = class extends Eventified {
     super();
     this._hooks = /* @__PURE__ */ new Map();
   }
-  // Adds a handler function for a specific event
+  /**
+   * Adds a handler function for a specific event
+   * @param {string} event
+   * @param {Hook} handler - this can be async or sync
+   * @returns {void}
+   */
   onHook(event, handler) {
     const eventHandlers = this._hooks.get(event);
     if (eventHandlers) {
@@ -138,7 +224,24 @@ var Hookified = class extends Eventified {
       this._hooks.set(event, [handler]);
     }
   }
-  // Removes a specific handler function for a specific event
+  /**
+   * Adds a handler that only executes once for a specific event
+   * @param event
+   * @param handler
+   */
+  onceHook(event, handler) {
+    const hook = async (...arguments_) => {
+      this.removeHook(event, hook);
+      return handler(...arguments_);
+    };
+    this.onHook(event, hook);
+  }
+  /**
+   * Removes a handler function for a specific event
+   * @param {string} event
+   * @param {Hook} handler
+   * @returns {void}
+   */
   removeHook(event, handler) {
     const eventHandlers = this._hooks.get(event);
     if (eventHandlers) {
@@ -148,7 +251,12 @@ var Hookified = class extends Eventified {
       }
     }
   }
-  // Triggers all handlers for a specific event with provided data
+  /**
+   * Calls all handlers for a specific event
+   * @param {string} event
+   * @param {T[]} arguments_
+   * @returns {Promise<void>}
+   */
   async hook(event, ...arguments_) {
     const eventHandlers = this._hooks.get(event);
     if (eventHandlers) {
@@ -161,13 +269,25 @@ var Hookified = class extends Eventified {
       }
     }
   }
-  // Provides read-only access to the current handlers
+  /**
+   * Gets all hooks
+   * @returns {Map<string, Hook[]>}
+   */
   get hooks() {
     return this._hooks;
   }
+  /**
+   * Gets all hooks for a specific event
+   * @param {string} event
+   * @returns {Hook[]}
+   */
   getHooks(event) {
     return this._hooks.get(event);
   }
+  /**
+   * Removes all hooks
+   * @returns {void}
+   */
   clearHooks() {
     this._hooks.clear();
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hookified",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "description": "Event and Middleware Hooks",
   "type": "module",
   "main": "dist/node/index.cjs",
@@ -57,12 +57,12 @@
   },
   "homepage": "https://github.com/jaredwray/hookified#readme",
   "devDependencies": {
-    "@vitest/coverage-v8": "^2.1.3",
-    "docula": "^0.9.3",
+    "@vitest/coverage-v8": "^2.1.5",
+    "docula": "^0.9.5",
     "rimraf": "^6.0.1",
-    "tsup": "^8.3.0",
-    "typescript": "^5.6.3",
-    "vitest": "^2.1.3",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.5",
     "xo": "^0.59.3"
   },
   "files": [