@xylabs/creatable 5.0.83 → 5.0.84

package/README.md

@@ -178,6 +178,8 @@ protected _startPromise: Promisable<boolean> | undefined;
 eventData: TEventData;
 ```
 
+Type-level reference to the event data shape for external type queries.
+
 ### Inherited from
 
 ```ts
@@ -998,16 +1000,22 @@ Override in subclasses to define stop behavior. Throw an error on failure.
 clearListeners(eventNames): this;
 ```
 
+Removes all listeners for the specified event name(s).
+
 ### Parameters
 
 #### eventNames
 
+One or more event names to clear listeners for.
+
 keyof `TEventData` | keyof `TEventData`[]
 
 ### Returns
 
 `this`
 
+This instance for chaining.
+
 ### Inherited from
 
 ```ts
@@ -1022,6 +1030,8 @@ BaseEmitter.clearListeners
 emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
 ```
 
+Emits an event, invoking all registered listeners concurrently.
+
 ### Type Parameters
 
 #### TEventName
@@ -1038,10 +1048,14 @@ emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
 
 `TEventName`
 
+The event to emit.
+
 #### eventArgs
 
 `TEventArgs`
 
+The data to pass to listeners.
+
 ### Returns
 
 `Promise`\<`void`\>
@@ -1060,6 +1074,8 @@ BaseEmitter.emit
 emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
 ```
 
+Emits an event, invoking all registered listeners sequentially in order.
+
 ### Type Parameters
 
 #### TEventName
@@ -1076,10 +1092,14 @@ emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
 
 `TEventName`
 
+The event to emit.
+
 #### eventArgs
 
 `TEventArgs`
 
+The data to pass to listeners.
+
 ### Returns
 
 `Promise`\<`void`\>
@@ -1098,16 +1118,22 @@ BaseEmitter.emitSerial
 listenerCount(eventNames): number;
 ```
 
+Returns the total number of listeners registered for the specified event name(s).
+
 ### Parameters
 
 #### eventNames
 
+One or more event names to count listeners for.
+
 keyof `TEventData` | keyof `TEventData`[]
 
 ### Returns
 
 `number`
 
+The total listener count.
+
 ### Inherited from
 
 ```ts
@@ -1122,6 +1148,8 @@ BaseEmitter.listenerCount
 off<TEventName>(eventNames, listener): void;
 ```
 
+Removes a specific listener from the specified event name(s).
+
 ### Type Parameters
 
 #### TEventName
@@ -1132,12 +1160,16 @@ off<TEventName>(eventNames, listener): void;
 
 #### eventNames
 
+One or more event names to unsubscribe from.
+
 `TEventName` | `TEventName`[]
 
 #### listener
 
 `EventListener`\<`TEventData`\[`TEventName`\]\>
 
+The listener to remove.
+
 ### Returns
 
 `void`
@@ -1156,12 +1188,16 @@ BaseEmitter.off
 offAny(listener): void;
 ```
 
+Removes a wildcard listener that was receiving all events.
+
 ### Parameters
 
 #### listener
 
 `EventAnyListener`
 
+The wildcard listener to remove.
+
 ### Returns
 
 `void`
@@ -1180,6 +1216,8 @@ BaseEmitter.offAny
 on<TEventName>(eventNames, listener): () => void;
 ```
 
+Subscribes a listener to the specified event name(s).
+
 ### Type Parameters
 
 #### TEventName
@@ -1190,14 +1228,20 @@ on<TEventName>(eventNames, listener): () => void;
 
 #### eventNames
 
+One or more event names to listen for.
+
 `TEventName` | `TEventName`[]
 
 #### listener
 
 `EventListener`\<`TEventData`\[`TEventName`\]\>
 
+The callback to invoke when the event fires.
+
 ### Returns
 
+An unsubscribe function.
+
 ```ts
 (): void;
 ```
@@ -1220,14 +1264,20 @@ BaseEmitter.on
 onAny(listener): () => void;
 ```
 
+Subscribes a wildcard listener that receives all events.
+
 ### Parameters
 
 #### listener
 
 `EventAnyListener`
 
+The callback to invoke for any event.
+
 ### Returns
 
+An unsubscribe function.
+
 ```ts
 (): void;
 ```
@@ -1250,6 +1300,8 @@ BaseEmitter.onAny
 once<TEventName>(eventName, listener): () => void;
 ```
 
+Subscribes a listener that will be invoked only once for the specified event, then automatically removed.
+
 ### Type Parameters
 
 #### TEventName
@@ -1262,12 +1314,18 @@ once<TEventName>(eventName, listener): () => void;
 
 `TEventName`
 
+The event to listen for.
+
 #### listener
 
 `EventListener`\<`TEventData`\[`TEventName`\]\>
 
+The callback to invoke once.
+
 ### Returns
 
+An unsubscribe function.
+
 ```ts
 (): void;
 ```
@@ -1401,6 +1459,8 @@ protected _startPromise: Promisable<boolean> | undefined;
 eventData: TEventData;
 ```
 
+Type-level reference to the event data shape for external type queries.
+
 ### Inherited from
 
 [`AbstractCreatable`](#AbstractCreatable).[`eventData`](AbstractCreatable.md#eventdata)
@@ -2312,16 +2372,22 @@ Labels to assign to created instances
 clearListeners(eventNames): this;
 ```
 
+Removes all listeners for the specified event name(s).
+
 ### Parameters
 
 #### eventNames
 
+One or more event names to clear listeners for.
+
 keyof `TEventData` | keyof `TEventData`[]
 
 ### Returns
 
 `this`
 
+This instance for chaining.
+
 ### Inherited from
 
 [`AbstractCreatable`](#AbstractCreatable).[`clearListeners`](AbstractCreatable.md#clearlisteners)
@@ -2334,6 +2400,8 @@ keyof `TEventData` | keyof `TEventData`[]
 emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
 ```
 
+Emits an event, invoking all registered listeners concurrently.
+
 ### Type Parameters
 
 #### TEventName
@@ -2350,10 +2418,14 @@ emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
 
 `TEventName`
 
+The event to emit.
+
 #### eventArgs
 
 `TEventArgs`
 
+The data to pass to listeners.
+
 ### Returns
 
 `Promise`\<`void`\>
@@ -2370,6 +2442,8 @@ emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
 emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
 ```
 
+Emits an event, invoking all registered listeners sequentially in order.
+
 ### Type Parameters
 
 #### TEventName
@@ -2386,10 +2460,14 @@ emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
 
 `TEventName`
 
+The event to emit.
+
 #### eventArgs
 
 `TEventArgs`
 
+The data to pass to listeners.
+
 ### Returns
 
 `Promise`\<`void`\>
@@ -2406,16 +2484,22 @@ emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;
 listenerCount(eventNames): number;
 ```
 
+Returns the total number of listeners registered for the specified event name(s).
+
 ### Parameters
 
 #### eventNames
 
+One or more event names to count listeners for.
+
 keyof `TEventData` | keyof `TEventData`[]
 
 ### Returns
 
 `number`
 
+The total listener count.
+
 ### Inherited from
 
 [`AbstractCreatable`](#AbstractCreatable).[`listenerCount`](AbstractCreatable.md#listenercount)
@@ -2428,6 +2512,8 @@ keyof `TEventData` | keyof `TEventData`[]
 off<TEventName>(eventNames, listener): void;
 ```
 
+Removes a specific listener from the specified event name(s).
+
 ### Type Parameters
 
 #### TEventName
@@ -2438,12 +2524,16 @@ off<TEventName>(eventNames, listener): void;
 
 #### eventNames
 
+One or more event names to unsubscribe from.
+
 `TEventName` | `TEventName`[]
 
 #### listener
 
 `EventListener`\<`TEventData`\[`TEventName`\]\>
 
+The listener to remove.
+
 ### Returns
 
 `void`
@@ -2460,12 +2550,16 @@ off<TEventName>(eventNames, listener): void;
 offAny(listener): void;
 ```
 
+Removes a wildcard listener that was receiving all events.
+
 ### Parameters
 
 #### listener
 
 `EventAnyListener`
 
+The wildcard listener to remove.
+
 ### Returns
 
 `void`
@@ -2482,6 +2576,8 @@ offAny(listener): void;
 on<TEventName>(eventNames, listener): () => void;
 ```
 
+Subscribes a listener to the specified event name(s).
+
 ### Type Parameters
 
 #### TEventName
@@ -2492,14 +2588,20 @@ on<TEventName>(eventNames, listener): () => void;
 
 #### eventNames
 
+One or more event names to listen for.
+
 `TEventName` | `TEventName`[]
 
 #### listener
 
 `EventListener`\<`TEventData`\[`TEventName`\]\>
 
+The callback to invoke when the event fires.
+
 ### Returns
 
+An unsubscribe function.
+
 ```ts
 (): void;
 ```
@@ -2520,14 +2622,20 @@ on<TEventName>(eventNames, listener): () => void;
 onAny(listener): () => void;
 ```
 
+Subscribes a wildcard listener that receives all events.
+
 ### Parameters
 
 #### listener
 
 `EventAnyListener`
 
+The callback to invoke for any event.
+
 ### Returns
 
+An unsubscribe function.
+
 ```ts
 (): void;
 ```
@@ -2548,6 +2656,8 @@ onAny(listener): () => void;
 once<TEventName>(eventName, listener): () => void;
 ```
 
+Subscribes a listener that will be invoked only once for the specified event, then automatically removed.
+
 ### Type Parameters
 
 #### TEventName
@@ -2560,12 +2670,18 @@ once<TEventName>(eventName, listener): () => void;
 
 `TEventName`
 
+The event to listen for.
+
 #### listener
 
 `EventListener`\<`TEventData`\[`TEventName`\]\>
 
+The callback to invoke once.
+
 ### Returns
 
+An unsubscribe function.
+
 ```ts
 (): void;
 ```
@@ -3129,6 +3245,8 @@ Stops the instance. Resolves to true if stopped successfully.
 clearListeners(eventNames): void;
 ```
 
+Removes all listeners for the specified event name(s).
+
 ### Parameters
 
 #### eventNames
@@ -3153,6 +3271,8 @@ EventEmitter.clearListeners
 emit<TEventName>(eventName, eventArgs): Promise<void>;
 ```
 
+Emits an event, invoking all registered listeners concurrently.
+
 ### Type Parameters
 
 #### TEventName
@@ -3187,6 +3307,8 @@ EventEmitter.emit
 emitSerial<TEventName>(eventName, eventArgs): Promise<void>;
 ```
 
+Emits an event, invoking all registered listeners sequentially in order.
+
 ### Type Parameters
 
 #### TEventName
@@ -3221,6 +3343,8 @@ EventEmitter.emitSerial
 listenerCount(eventNames): number;
 ```
 
+Returns the total number of listeners registered for the specified event name(s).
+
 ### Parameters
 
 #### eventNames
@@ -3245,6 +3369,8 @@ EventEmitter.listenerCount
 off<TEventName>(eventNames, listener): void;
 ```
 
+Removes a specific listener from the specified event name(s).
+
 ### Type Parameters
 
 #### TEventName
@@ -3279,6 +3405,8 @@ EventEmitter.off
 offAny(listener): void;
 ```
 
+Removes a wildcard listener that was receiving all events.
+
 ### Parameters
 
 #### listener
@@ -3303,6 +3431,8 @@ EventEmitter.offAny
 on<TEventName>(eventNames, listener): EventUnsubscribeFunction;
 ```
 
+Subscribes a listener to the specified event name(s) and returns an unsubscribe function.
+
 ### Type Parameters
 
 #### TEventName
@@ -3337,6 +3467,8 @@ EventEmitter.on
 onAny(listener): EventUnsubscribeFunction;
 ```
 
+Subscribes a wildcard listener that receives all events and returns an unsubscribe function.
+
 ### Parameters
 
 #### listener
@@ -3361,6 +3493,8 @@ EventEmitter.onAny
 once<TEventName>(eventName, listener): EventUnsubscribeFunction;
 ```
 
+Subscribes a listener that will be invoked only once for the specified event, then automatically removed.
+
 ### Type Parameters
 
 #### TEventName

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/creatable",
-  "version": "5.0.83",
+  "version": "5.0.84",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -35,18 +35,18 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/assert": "~5.0.83",
-    "@xylabs/base": "~5.0.83",
-    "@xylabs/events": "~5.0.83",
-    "@xylabs/logger": "~5.0.83",
-    "@xylabs/promise": "~5.0.83",
-    "@xylabs/telemetry": "~5.0.83",
-    "@xylabs/typeof": "~5.0.83",
+    "@xylabs/assert": "~5.0.84",
+    "@xylabs/base": "~5.0.84",
+    "@xylabs/events": "~5.0.84",
+    "@xylabs/logger": "~5.0.84",
+    "@xylabs/promise": "~5.0.84",
+    "@xylabs/telemetry": "~5.0.84",
+    "@xylabs/typeof": "~5.0.84",
     "async-mutex": "~0.5.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.13",
+    "@xylabs/tsconfig": "~7.4.13",
     "tslib": "^2.8.1",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"