@axi-engine/utils 0.1.4 → 0.1.5

package/README.md

@@ -30,7 +30,7 @@ const isSame = haveSameElements(['a', 'b'], ['b', 'a']); // Returns true
 ```
 
 
-API Reference
+## API Reference
 
 Will be available when code and repository will be fully published 
 

package/dist/index.d.mts

@@ -120,6 +120,37 @@ declare const axiSettings: AxiEngineConfig;
  */
 declare function configure(newConfig: Partial<AxiEngineConfig>): void;
 
+/**
+ * A minimal, type-safe event emitter for a single event.
+ * It does not manage state, it only manages subscribers and event dispatching.
+ * @template T A tuple representing the types of the event arguments.
+ */
+declare class Emitter<T extends any[]> {
+    private listeners;
+    /**
+     * Subscribes a listener to this event.
+     * @returns A function to unsubscribe the listener.
+     */
+    subscribe(listener: (...args: T) => void): () => void;
+    /**
+     * Manually unsubscribe by listener
+     * @returns returns true if an listener has been removed, or false if the listener does not exist.
+     */
+    unsubscribe(listener: (...args: T) => void): boolean;
+    /**
+     * Dispatches the event to all subscribed listeners.
+     */
+    emit(...args: T): void;
+    /**
+     * Clears all listeners.
+     */
+    clear(): void;
+    /**
+     * Returns the number of listeners.
+     */
+    get listenerCount(): number;
+}
+
 declare function isNullOrUndefined(val: unknown): val is null | undefined;
 declare function isUndefined(val: unknown): val is undefined;
 declare function isNumber(val: unknown): val is number;
@@ -179,4 +210,4 @@ declare function randInt(min: number, max: number): number;
  */
 declare function randId(): string;
 
-export { type AxiEngineConfig, type PathType, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNullOrUndefined, isNumber, isPercentageString, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwIf, throwIfEmpty, unique };
+export { type AxiEngineConfig, Emitter, type PathType, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNullOrUndefined, isNumber, isPercentageString, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwIf, throwIfEmpty, unique };

package/dist/index.d.ts

@@ -120,6 +120,37 @@ declare const axiSettings: AxiEngineConfig;
  */
 declare function configure(newConfig: Partial<AxiEngineConfig>): void;
 
+/**
+ * A minimal, type-safe event emitter for a single event.
+ * It does not manage state, it only manages subscribers and event dispatching.
+ * @template T A tuple representing the types of the event arguments.
+ */
+declare class Emitter<T extends any[]> {
+    private listeners;
+    /**
+     * Subscribes a listener to this event.
+     * @returns A function to unsubscribe the listener.
+     */
+    subscribe(listener: (...args: T) => void): () => void;
+    /**
+     * Manually unsubscribe by listener
+     * @returns returns true if an listener has been removed, or false if the listener does not exist.
+     */
+    unsubscribe(listener: (...args: T) => void): boolean;
+    /**
+     * Dispatches the event to all subscribed listeners.
+     */
+    emit(...args: T): void;
+    /**
+     * Clears all listeners.
+     */
+    clear(): void;
+    /**
+     * Returns the number of listeners.
+     */
+    get listenerCount(): number;
+}
+
 declare function isNullOrUndefined(val: unknown): val is null | undefined;
 declare function isUndefined(val: unknown): val is undefined;
 declare function isNumber(val: unknown): val is number;
@@ -179,4 +210,4 @@ declare function randInt(min: number, max: number): number;
  */
 declare function randId(): string;
 
-export { type AxiEngineConfig, type PathType, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNullOrUndefined, isNumber, isPercentageString, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwIf, throwIfEmpty, unique };
+export { type AxiEngineConfig, Emitter, type PathType, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNullOrUndefined, isNumber, isPercentageString, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwIf, throwIfEmpty, unique };

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, {
+  Emitter: () => Emitter,
   areArraysEqual: () => areArraysEqual,
   axiSettings: () => axiSettings,
   clampNumber: () => clampNumber,
@@ -136,6 +137,46 @@ function configure(newConfig) {
   Object.assign(axiSettings, newConfig);
 }
 
+// src/emitter.ts
+var Emitter = class {
+  constructor() {
+    this.listeners = /* @__PURE__ */ new Set();
+  }
+  /**
+   * Subscribes a listener to this event.
+   * @returns A function to unsubscribe the listener.
+   */
+  subscribe(listener) {
+    this.listeners.add(listener);
+    return () => this.listeners.delete(listener);
+  }
+  /**
+   * Manually unsubscribe by listener
+   * @returns returns true if an listener has been removed, or false if the listener does not exist.
+   */
+  unsubscribe(listener) {
+    return this.listeners.delete(listener);
+  }
+  /**
+   * Dispatches the event to all subscribed listeners.
+   */
+  emit(...args) {
+    this.listeners.forEach((listener) => listener(...args));
+  }
+  /**
+   * Clears all listeners.
+   */
+  clear() {
+    this.listeners.clear();
+  }
+  /**
+   * Returns the number of listeners.
+   */
+  get listenerCount() {
+    return this.listeners.size;
+  }
+};
+
 // src/math.ts
 function clampNumber(val, min, max) {
   if (!isNullOrUndefined(min)) val = Math.max(val, min);
@@ -171,6 +212,7 @@ function randId() {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  Emitter,
   areArraysEqual,
   axiSettings,
   clampNumber,

package/dist/index.mjs

@@ -86,6 +86,46 @@ function configure(newConfig) {
   Object.assign(axiSettings, newConfig);
 }
 
+// src/emitter.ts
+var Emitter = class {
+  constructor() {
+    this.listeners = /* @__PURE__ */ new Set();
+  }
+  /**
+   * Subscribes a listener to this event.
+   * @returns A function to unsubscribe the listener.
+   */
+  subscribe(listener) {
+    this.listeners.add(listener);
+    return () => this.listeners.delete(listener);
+  }
+  /**
+   * Manually unsubscribe by listener
+   * @returns returns true if an listener has been removed, or false if the listener does not exist.
+   */
+  unsubscribe(listener) {
+    return this.listeners.delete(listener);
+  }
+  /**
+   * Dispatches the event to all subscribed listeners.
+   */
+  emit(...args) {
+    this.listeners.forEach((listener) => listener(...args));
+  }
+  /**
+   * Clears all listeners.
+   */
+  clear() {
+    this.listeners.clear();
+  }
+  /**
+   * Returns the number of listeners.
+   */
+  get listenerCount() {
+    return this.listeners.size;
+  }
+};
+
 // src/math.ts
 function clampNumber(val, min, max) {
   if (!isNullOrUndefined(min)) val = Math.max(val, min);
@@ -120,6 +160,7 @@ function randId() {
   return uuidv4();
 }
 export {
+  Emitter,
   areArraysEqual,
   axiSettings,
   clampNumber,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axi-engine/utils",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Core utility library for Axi Engine, providing common functions for arrays, math, type guards, and more.",
   "license": "MIT",
   "keywords": [
@@ -9,14 +9,14 @@
     "gamedev",
     "utils"
   ],
+  "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.js"
     }
   },
   "scripts": {