@axijs/emitter 1.1.0 → 1.2.0

package/dist/index.d.mts

@@ -1,19 +1,19 @@
-type ListenerType<T> = (value: T) => void;
+type Listener<T> = (value: T) => Promise<void> | void;
 /**
  * Defines the public, read-only contract for an event emitter.
  * It allows subscribing to an event but not emitting it.
  * @template T The type of the emitted value.
  */
-type Subscribable<T> = {
+interface Subscribable<T> {
     readonly listenerCount: number;
     /**
      * Subscribes a listener to this event.
      * @returns A function to unsubscribe the listener.
      */
-    subscribe(listener: (value: T) => void): Unsubscribable;
-    unsubscribe(listener: (value: T) => void): boolean;
+    subscribe(listener: Listener<T>): Unsubscribable;
+    unsubscribe(listener: Listener<T>): boolean;
     clear(): void;
-};
+}
 /**
  * Describes an object that can be unsubscribed from.
  */
@@ -55,7 +55,7 @@ declare class Subscription implements Unsubscribable {
  * @template T The type of the emitted value.
  */
 declare class Emitter<T = void> implements Subscribable<T> {
-    private listeners;
+    protected listeners: Set<Listener<T>>;
     /**
      * Returns the number of listeners.
      */
@@ -64,18 +64,18 @@ declare class Emitter<T = void> implements Subscribable<T> {
      * Subscribes a listener to this event.
      * @returns A Subscription object to manage the unsubscription.
      */
-    subscribe(listener: ListenerType<T>): Subscription;
+    subscribe(listener: Listener<T>): Subscription;
     /**
      * Subscribes a listener that triggers only once and then automatically unsubscribes.
      * @param listener The callback function to execute once.
      * @returns A Subscription object (can be used to cancel before the event fires).
      */
-    once(listener: ListenerType<T>): Subscription;
+    once(listener: Listener<T>): Subscription;
     /**
      * Manually unsubscribe by listener.
      * @returns returns true if a listener has been removed, or false if it does not exist.
      */
-    unsubscribe(listener: ListenerType<T>): boolean;
+    unsubscribe(listener: Listener<T>): boolean;
     /**
      * Dispatches the event to all subscribed listeners.
      */
@@ -86,6 +86,16 @@ declare class Emitter<T = void> implements Subscribable<T> {
     clear(): void;
 }
 
+/**
+ * An emitter intended for cases where listeners need to finish their work before
+ * the next event is handled, such as animations or async side effects.
+ * Use with caution when the generation rate of new events can be higher than the
+ * time required for a listener to react.
+ */
+declare class AsyncEmitter<T = void> extends Emitter<T> {
+    emit(value: T): Promise<void>;
+}
+
 interface StateEmitterOptions<T> {
     distinct?: boolean;
     compare?: (prev: T, next: T) => boolean;
@@ -121,4 +131,4 @@ declare class StateEmitter<T> extends Emitter<T> {
     clear(): void;
 }
 
-export { Emitter, type ListenerType, StateEmitter, type StateEmitterOptions, type Subscribable, Subscription, type Unsubscribable };
+export { AsyncEmitter, Emitter, type Listener, StateEmitter, type StateEmitterOptions, type Subscribable, Subscription, type Unsubscribable };

package/dist/index.d.ts

@@ -1,19 +1,19 @@
-type ListenerType<T> = (value: T) => void;
+type Listener<T> = (value: T) => Promise<void> | void;
 /**
  * Defines the public, read-only contract for an event emitter.
  * It allows subscribing to an event but not emitting it.
  * @template T The type of the emitted value.
  */
-type Subscribable<T> = {
+interface Subscribable<T> {
     readonly listenerCount: number;
     /**
      * Subscribes a listener to this event.
      * @returns A function to unsubscribe the listener.
      */
-    subscribe(listener: (value: T) => void): Unsubscribable;
-    unsubscribe(listener: (value: T) => void): boolean;
+    subscribe(listener: Listener<T>): Unsubscribable;
+    unsubscribe(listener: Listener<T>): boolean;
     clear(): void;
-};
+}
 /**
  * Describes an object that can be unsubscribed from.
  */
@@ -55,7 +55,7 @@ declare class Subscription implements Unsubscribable {
  * @template T The type of the emitted value.
  */
 declare class Emitter<T = void> implements Subscribable<T> {
-    private listeners;
+    protected listeners: Set<Listener<T>>;
     /**
      * Returns the number of listeners.
      */
@@ -64,18 +64,18 @@ declare class Emitter<T = void> implements Subscribable<T> {
      * Subscribes a listener to this event.
      * @returns A Subscription object to manage the unsubscription.
      */
-    subscribe(listener: ListenerType<T>): Subscription;
+    subscribe(listener: Listener<T>): Subscription;
     /**
      * Subscribes a listener that triggers only once and then automatically unsubscribes.
      * @param listener The callback function to execute once.
      * @returns A Subscription object (can be used to cancel before the event fires).
      */
-    once(listener: ListenerType<T>): Subscription;
+    once(listener: Listener<T>): Subscription;
     /**
      * Manually unsubscribe by listener.
      * @returns returns true if a listener has been removed, or false if it does not exist.
      */
-    unsubscribe(listener: ListenerType<T>): boolean;
+    unsubscribe(listener: Listener<T>): boolean;
     /**
      * Dispatches the event to all subscribed listeners.
      */
@@ -86,6 +86,16 @@ declare class Emitter<T = void> implements Subscribable<T> {
     clear(): void;
 }
 
+/**
+ * An emitter intended for cases where listeners need to finish their work before
+ * the next event is handled, such as animations or async side effects.
+ * Use with caution when the generation rate of new events can be higher than the
+ * time required for a listener to react.
+ */
+declare class AsyncEmitter<T = void> extends Emitter<T> {
+    emit(value: T): Promise<void>;
+}
+
 interface StateEmitterOptions<T> {
     distinct?: boolean;
     compare?: (prev: T, next: T) => boolean;
@@ -121,4 +131,4 @@ declare class StateEmitter<T> extends Emitter<T> {
     clear(): void;
 }
 
-export { Emitter, type ListenerType, StateEmitter, type StateEmitterOptions, type Subscribable, Subscription, type Unsubscribable };
+export { AsyncEmitter, Emitter, type Listener, StateEmitter, type StateEmitterOptions, type Subscribable, Subscription, type Unsubscribable };

package/dist/index.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  AsyncEmitter: () => AsyncEmitter,
   Emitter: () => Emitter,
   StateEmitter: () => StateEmitter,
   Subscription: () => Subscription
@@ -119,6 +120,14 @@ var Emitter = class {
   }
 };
 
+// src/async-emitter.ts
+var AsyncEmitter = class extends Emitter {
+  async emit(value) {
+    const results = Array.from(this.listeners).map((listener) => listener(value));
+    await Promise.all(results);
+  }
+};
+
 // src/state-emitter.ts
 var StateEmitter = class extends Emitter {
   _lastValue;
@@ -170,6 +179,7 @@ var StateEmitter = class extends Emitter {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  AsyncEmitter,
   Emitter,
   StateEmitter,
   Subscription

package/dist/index.mjs

@@ -91,6 +91,14 @@ var Emitter = class {
   }
 };
 
+// src/async-emitter.ts
+var AsyncEmitter = class extends Emitter {
+  async emit(value) {
+    const results = Array.from(this.listeners).map((listener) => listener(value));
+    await Promise.all(results);
+  }
+};
+
 // src/state-emitter.ts
 var StateEmitter = class extends Emitter {
   _lastValue;
@@ -141,6 +149,7 @@ var StateEmitter = class extends Emitter {
   }
 };
 export {
+  AsyncEmitter,
   Emitter,
   StateEmitter,
   Subscription

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axijs/emitter",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "A minimalistic, type-safe library for single-event and state emitting",
   "license": "MIT",
   "homepage": "https://github.com/axijs/tools/tree/main/packages/emitter",
@@ -9,8 +9,7 @@
     "url": "https://github.com/axijs/tools.git",
     "directory": "packages/emitter"
   },
-  "keywords": [
-  ],
+  "keywords": [],
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",