@axi-engine/utils 0.1.7 → 0.1.8

package/dist/index.d.mts

@@ -1,3 +1,4 @@
+//#region src/types.d.ts
 /**
  * Represents a path that can be provided as a single string
  * or an array of segments.
@@ -38,16 +39,17 @@ type Constructor<T = {}> = new (...args: any[]) => T;
  * @template T A tuple representing the types of the event arguments.
  */
 type Subscribable<T extends any[]> = {
-    readonly listenerCount: number;
-    /**
-     * Subscribes a listener to this event.
-     * @returns A function to unsubscribe the listener.
-     */
-    subscribe(listener: (...args: T) => void): () => void;
-    unsubscribe(listener: (...args: T) => void): boolean;
-    clear(): void;
+  readonly listenerCount: number;
+  /**
+       * Subscribes a listener to this event.
+       * @returns A function to unsubscribe the listener.
+       */
+  subscribe(listener: (...args: T) => void): () => void;
+  unsubscribe(listener: (...args: T) => void): boolean;
+  clear(): void;
 };
-
+//#endregion
+//#region src/arrays.d.ts
 /**
  * Generates an array of numbers from 0 to length-1.
  * @param length The desired length of the array.
@@ -119,7 +121,8 @@ declare function unique<T>(array: T[]): T[];
  * @returns A random element from the array, or `undefined` if the array is empty.
  */
 declare function getRandomElement<T>(array: T[]): T | undefined;
-
+//#endregion
+//#region src/assertion.d.ts
 /**
  * Throws an error if the condition is true.
  * @param conditionForThrow - If true, an error will be thrown.
@@ -150,9 +153,10 @@ declare function throwIf(conditionForThrow: boolean, exceptionMessage: string):
  * console.log('First item:', items[0]);
  */
 declare function throwIfEmpty<T>(value: T, exceptionMessage: string): asserts value is NonNullable<T>;
-
+//#endregion
+//#region src/config.d.ts
 interface AxiEngineConfig {
-    pathSeparator: string;
+  pathSeparator: string;
 }
 declare const axiSettings: AxiEngineConfig;
 /**
@@ -160,7 +164,8 @@ declare const axiSettings: AxiEngineConfig;
  * @param newConfig - configuration object
  */
 declare function configure(newConfig: Partial<AxiEngineConfig>): void;
-
+//#endregion
+//#region src/constructor-registry.d.ts
 /**
  * A generic registry for mapping string identifiers to class constructors.
  *
@@ -170,67 +175,69 @@ declare function configure(newConfig: Partial<AxiEngineConfig>): void;
  * @template T - A base type that all registered constructors must produce an instance of.
  */
 declare class ConstructorRegistry<T> {
-    private readonly items;
-    /**
-     * Registers a constructor with a unique string identifier.
-     *
-     * @param typeId - The unique identifier for the constructor (e.g., a static `typeName` property from a class).
-     * @param ctor - The class constructor to register.
-     * @returns The registry instance for chainable calls.
-     * @throws If a constructor with the same `typeId` is already registered.
-     */
-    register(typeId: string, ctor: Constructor<T>): this;
-    /**
-     * Retrieves a constructor by its identifier.
-     *
-     * @param typeId - The identifier of the constructor to retrieve.
-     * @returns The found class constructor.
-     * @throws If no constructor is found for the given `typeId`.
-     */
-    get(typeId: string): Constructor<T>;
-    /**
-     * Checks if a constructor for a given identifier is registered.
-     * @param typeId - The identifier to check.
-     * @returns `true` if a constructor is registered, otherwise `false`.
-     */
-    has(typeId: string): boolean;
-    /**
-     * Clears all registered constructors from the registry.
-     */
-    clear(): void;
+  private readonly items;
+  /**
+       * Registers a constructor with a unique string identifier.
+       *
+       * @param typeId - The unique identifier for the constructor (e.g., a static `typeName` property from a class).
+       * @param ctor - The class constructor to register.
+       * @returns The registry instance for chainable calls.
+       * @throws If a constructor with the same `typeId` is already registered.
+       */
+  register(typeId: string, ctor: Constructor<T>): this;
+  /**
+       * Retrieves a constructor by its identifier.
+       *
+       * @param typeId - The identifier of the constructor to retrieve.
+       * @returns The found class constructor.
+       * @throws If no constructor is found for the given `typeId`.
+       */
+  get(typeId: string): Constructor<T>;
+  /**
+       * Checks if a constructor for a given identifier is registered.
+       * @param typeId - The identifier to check.
+       * @returns `true` if a constructor is registered, otherwise `false`.
+       */
+  has(typeId: string): boolean;
+  /**
+       * Clears all registered constructors from the registry.
+       */
+  clear(): void;
 }
-
+//#endregion
+//#region src/emitter.d.ts
 /**
  * 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[]> implements Subscribable<T> {
-    private listeners;
-    /**
-     * Returns the number of listeners.
-     */
-    get listenerCount(): number;
-    /**
-     * 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;
+  private listeners;
+  /**
+       * Returns the number of listeners.
+       */
+  get listenerCount(): number;
+  /**
+       * 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;
 }
-
+//#endregion
+//#region src/guards.d.ts
 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;
@@ -242,7 +249,8 @@ declare function isString(val: unknown): val is string;
  * @returns `true` if the value is a percentage string.
  */
 declare function isPercentageString(val: unknown): val is string;
-
+//#endregion
+//#region src/math.d.ts
 /**
  * Clamps a number between an optional minimum and maximum value.
  * @param val The number to clamp.
@@ -259,14 +267,16 @@ declare function clampNumber(val: number, min?: number | null, max?: number | nu
  * @example getPercentOf(200, 10); // returns 20
  */
 declare function getPercentOf(val: number, percents: number): number;
-
+//#endregion
+//#region src/misc.d.ts
 /**
  * Returns the first key of an object.
  * @param obj The object from which to get the key.
  * @returns The first key of the object as a string.
  */
 declare function firstKeyOf(obj: any): string;
-
+//#endregion
+//#region src/path.d.ts
 /**
  * Ensures that the given path is returned as an array of segments.
  */
@@ -275,7 +285,8 @@ declare function ensurePathArray(path: PathType, separator?: string): string[];
  * Ensures that the given path is returned as a single string.
  */
 declare function ensurePathString(path: PathType, separator?: string): string;
-
+//#endregion
+//#region src/random.d.ts
 /**
  * Returns a random integer between min (inclusive) and max (exclusive).
  * @param min The minimum integer (inclusive).
@@ -289,5 +300,6 @@ declare function randInt(min: number, max: number): number;
  * @returns A unique string ID.
  */
 declare function randId(): string;
-
-export { type AxiEngineConfig, type Constructor, ConstructorRegistry, Emitter, type PathType, type Subscribable, 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 };
+//#endregion
+export { AxiEngineConfig, Constructor, ConstructorRegistry, Emitter, PathType, Subscribable, 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 };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/arrays.ts","../src/assertion.ts","../src/config.ts","../src/constructor-registry.ts","../src/emitter.ts","../src/guards.ts","../src/math.ts","../src/misc.ts","../src/path.ts","../src/random.ts"],"mappings":";;AAOA;AA2BA;AAOA;;;;KAlCY,QAAA;AAAA;AA2BZ;AAOA;;;;ACnCA;AAWA;AAkBA;AAmBA;AAuBA;AAcA;AAUA;AAUA;;;;ACvGA;AA4BA;;;;;;;AF7BY,KA2BA,WAAA,mBAAA,IAAA,YAA8C,CAAA;AAAA;AAO1D;;;;AAP0D,KAO9C,YAAA;EAAA,SAAA,aAAA;EAAA;;;;EAAA,SAAA,CAAA,QAAA,MAAA,IAAA,EAOoB,CAAA;EAAA,WAAA,CAAA,QAAA,MAAA,IAAA,EAEE,CAAA;EAAA,KAAA;AAAA;;;;AC5ClC;AAWA;AAkBA;AAmBA;AAuBA;iBAvEgB,QAAA,CAAA,MAAA;AAAA;AAWhB;AAkBA;AAmBA;AAuBA;AAcA;AAUA;AA/FgB,iBAWA,YAAA,GAAA,CAAA,KAAA,EAAuB,CAAA,KAAM,CAAA;AAAA;AAkB7C;AAmBA;AAuBA;AAcA;AAUA;AAUA;;;AA9F6C,iBAkB7B,iBAAA,GAAA,CAAA,IAAA,EAA2B,CAAA,IAAA,IAAA,EAAW,CAAA;AAAA;AAmBtD;AAuBA;AAcA;AAUA;AAUA;;;;ACvGA;AA4BA;;ADDsD,iBAmBtC,gBAAA,GAAA,CAAA,IAAA,GAA2B,CAAA,IAAA,IAAA,GAAY,CAAA;AAAA;AAuBvD;AAcA;AAUA;AAUA;;;;ACvGA;AA4BA;;ADkBuD,iBAuBvC,cAAA,GAAA,CAAA,IAAA,GAAyB,CAAA,IAAA,IAAA,GAAY,CAAA;AAAA;AAcrD;AAUA;AAUA;;;AAlCqD,iBAcrC,IAAA,GAAA,CAAA,KAAA,EAAe,CAAA,KAAM,CAAA;AAAA;AAUrC;AAUA;;;;AApBqC,iBAUrB,MAAA,GAAA,CAAA,KAAA,EAAiB,CAAA,KAAM,CAAA;AAAA;AAUvC;;;;ACvGA;AD6FuC,iBAUvB,gBAAA,GAAA,CAAA,KAAA,EAA2B,CAAA,KAAM,CAAA;;;;ACvGjD;AA4BA;;;;iBA5BgB,OAAA,CAAA,iBAAA,WAAA,gBAAA;AAAA;AA4BhB;;;;;;;;ACpCA;AAYA;AAMA;;;;ACRA;;;;;;;AFFgB,iBA4BA,YAAA,GAAA,CAAA,KAAA,EACP,CAAA,EAAA,gBAAA,mBAAA,KAAA,IAEW,WAAA,CAAY,CAAA;;;UCvCf,eAAA;EAAA,aAAA;AAAA;AAAA,cAYJ,WAAA,EAAa,eAAA;AAAA;AAM1B;;;AAN0B,iBAMV,SAAA,CAAA,SAAA,EAAqB,OAAA,CAAQ,eAAA;;;;ACR7C;;;;;;;cAAa,mBAAA;EAAA,iBAAA,KAAA;EAAA;;;;;;;;EAAA,SAAA,MAAA,UAAA,IAAA,EAWoB,WAAA,CAAY,CAAA;EAAA;;;;;;;EAAA,IAAA,MAAA,WAatB,WAAA,CAAY,CAAA;EAAA;;;;;EAAA,IAAA,MAAA;EAAA;;;EAAA,MAAA;AAAA;;;;ACzBnC;;;;cAAa,OAAA,6BAAoC,YAAA,CAAa,CAAA;EAAA,QAAA,SAAA;EAAA;;;EAAA,IAAA,cAAA;EAAA;;;;EAAA,UAAA,QAAA,MAAA,IAAA,EAc9B,CAAA;EAAA;;;;EAAA,YAAA,QAAA,MAAA,IAAA,EASE,CAAA;EAAA;;;EAAA,KAAA,GAAA,IAAA,EAOlB,CAAA;EAAA;;;EAAA,MAAA;AAAA;;;iBCvCA,iBAAA,CAAA,GAAA,YAAA,GAAA;AAAA,iBAIA,WAAA,CAAA,GAAA,YAAA,GAAA;AAAA,iBAIA,QAAA,CAAA,GAAA,YAAA,GAAA;AAAA,iBAIA,SAAA,CAAA,GAAA,YAAA,GAAA;AAAA,iBAIA,QAAA,CAAA,GAAA,YAAA,GAAA;AAAA;AAShB;;;;AATgB,iBASA,kBAAA,CAAA,GAAA,YAAA,GAAA;;;;ACfhB;AAaA;;;;AClBA;iBDKgB,WAAA,CAAA,GAAA,UAAA,GAAA,kBAAA,GAAA;AAAA;AAahB;;;;AClBA;;ADKgB,iBAaA,YAAA,CAAA,GAAA,UAAA,QAAA;;;;AClBhB;;;;iBAAgB,UAAA,CAAA,GAAA;;;;ACChB;AAOA;iBAPgB,eAAA,CAAA,IAAA,EAAsB,QAAA,EAAA,SAAA;AAAA;AAOtC;;AAPsC,iBAOtB,gBAAA,CAAA,IAAA,EAAuB,QAAA,EAAA,SAAA;;;;ACJvC;AAUA;;;;;iBAVgB,OAAA,CAAA,GAAA,UAAA,GAAA;AAAA;AAUhB;;;AAVgB,iBAUA,MAAA,CAAA"}