@asaidimu/utils-database 3.1.4 → 3.1.5

package/index.d.mts

@@ -816,16 +816,18 @@ interface EventBus<TEventMap extends Record<string, any>> {
      * Subscribes to a specific event by name.
      * @param eventName - The name of the event to subscribe to.
      * @param callback - The function to call when the event is emitted.
+     * @param options -  Extra options to determine the behaviour of the
+     * subscription
      * @returns A function to unsubscribe from the event.
      */
-    subscribe: <TEventName extends keyof TEventMap>(eventName: TEventName, callback: (payload: TEventMap[TEventName]) => void) => () => void;
+    subscribe: <TEventName extends keyof TEventMap>(eventName: TEventName, callback: (payload: TEventMap[TEventName]) => void, options?: SubscribeOptions) => () => void;
     /**
      * Subscribes to an event and automatically unsubscribes after it fires once.
      * @param eventName - The name of the event to subscribe to.
      * @param callback - The function to call when the event is emitted.
      * @returns A function to cancel the one-shot subscription before it fires.
      */
-    once: <TEventName extends keyof TEventMap>(eventName: TEventName, callback: (payload: TEventMap[TEventName]) => void) => () => void;
+    once: <TEventName extends keyof TEventMap>(eventName: TEventName, callback: (payload: TEventMap[TEventName]) => void, options?: SubscribeOptions) => () => void;
     /**
      * Emits an event with a payload to all subscribed listeners.
      * @param event - An object containing the event name and payload.
@@ -859,6 +861,14 @@ interface EventMetrics {
     /** Average duration of event dispatch in milliseconds. */
     averageEmitDuration: number;
 }
+interface SubscribeOptions {
+    /**
+     * Debounce delay in milliseconds. When multiple events arrive in quick
+     * succession, the callback runs only after the quiet period ends, using the
+     * latest payload. Default = no debouncing.
+     */
+    debounce?: number;
+}
 
 interface MiddlewareContext {
     collection?: string;

package/index.d.ts

@@ -816,16 +816,18 @@ interface EventBus<TEventMap extends Record<string, any>> {
      * Subscribes to a specific event by name.
      * @param eventName - The name of the event to subscribe to.
      * @param callback - The function to call when the event is emitted.
+     * @param options -  Extra options to determine the behaviour of the
+     * subscription
      * @returns A function to unsubscribe from the event.
      */
-    subscribe: <TEventName extends keyof TEventMap>(eventName: TEventName, callback: (payload: TEventMap[TEventName]) => void) => () => void;
+    subscribe: <TEventName extends keyof TEventMap>(eventName: TEventName, callback: (payload: TEventMap[TEventName]) => void, options?: SubscribeOptions) => () => void;
     /**
      * Subscribes to an event and automatically unsubscribes after it fires once.
      * @param eventName - The name of the event to subscribe to.
      * @param callback - The function to call when the event is emitted.
      * @returns A function to cancel the one-shot subscription before it fires.
      */
-    once: <TEventName extends keyof TEventMap>(eventName: TEventName, callback: (payload: TEventMap[TEventName]) => void) => () => void;
+    once: <TEventName extends keyof TEventMap>(eventName: TEventName, callback: (payload: TEventMap[TEventName]) => void, options?: SubscribeOptions) => () => void;
     /**
      * Emits an event with a payload to all subscribed listeners.
      * @param event - An object containing the event name and payload.
@@ -859,6 +861,14 @@ interface EventMetrics {
     /** Average duration of event dispatch in milliseconds. */
     averageEmitDuration: number;
 }
+interface SubscribeOptions {
+    /**
+     * Debounce delay in milliseconds. When multiple events arrive in quick
+     * succession, the callback runs only after the quiet period ends, using the
+     * latest payload. Default = no debouncing.
+     */
+    debounce?: number;
+}
 
 interface MiddlewareContext {
     collection?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asaidimu/utils-database",
-  "version": "3.1.4",
+  "version": "3.1.5",
   "description": "A collection of database utilities.",
   "main": "index.js",
   "module": "index.mjs",
@@ -36,7 +36,7 @@
   },
   "dependencies": {
     "@asaidimu/anansi": "4.0.2",
-    "@asaidimu/utils-events": "1.1.0"
+    "@asaidimu/utils-events": "^1.0.0"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",