@axi-engine/utils 0.2.6 → 0.2.7

package/dist/index.d.mts

@@ -270,12 +270,64 @@ declare class Emitter<T extends any[]> implements Subscribable<T> {
  * @returns True if the value is a string, number, or boolean.
  */
 declare function isScalar(value: unknown): value is ScalarType;
-declare function isNullOrUndefined(val: unknown): val is null | undefined;
+/**
+* Type guard that checks if a value is `null`.
+* @param val The value to check.
+* @returns {boolean} `true` if the value is `null`, otherwise `false`.
+*/
+declare function isNull(val: unknown): val is null;
+/**
+* Type guard that checks if a value is `undefined`.
+* @param val The value to check.
+* @returns {boolean} `true` if the value is `undefined`, otherwise `false`.
+*/
 declare function isUndefined(val: unknown): val is undefined;
+/**
+ * Type guard that checks if a value is either `null` or `undefined`.
+ * @param val The value to check.
+ * @returns {boolean} `true` if the value is `null` or `undefined`, otherwise `false`.
+ */
+declare function isNullOrUndefined(val: unknown): val is null | undefined;
+/**
+* Type guard that checks if a value is a `number`.
+* @param val The value to check.
+* @returns {boolean} `true` if the value is a `number`, otherwise `false`.
+*/
 declare function isNumber(val: unknown): val is number;
+/**
+ * Type guard that checks if a value is a `boolean`.
+ * @param val The value to check.
+ * @returns {boolean} `true` if the value is a `boolean`, otherwise `false`.
+ */
 declare function isBoolean(val: unknown): val is boolean;
+/**
+ * Type guard that checks if a value is a `string`.
+ * @param val The value to check.
+ * @returns {boolean} `true` if the value is a `string`, otherwise `false`.
+ */
 declare function isString(val: unknown): val is string;
-declare function isNull(val: unknown): val is null;
+/**
+ * Check if a value is a plain object.
+ * Correctly handles `null` and arrays, returning `false` for them.
+ *
+ * @param value The value to check.
+ * @returns {boolean} `true` if the value is a non-null, non-array object.
+ */
+declare function isObject(value: unknown): value is Record<PropertyKey, unknown>;
+/**
+ * Type guard that checks if a value is a function.
+ *
+ * @param value The value to check.
+ * @returns {boolean} `true` if the value is a function.
+ */
+declare function isFunction(value: unknown): value is (...args: any[]) => any;
+/**
+ * Type guard that checks if a value is a Promise-like object.
+ *
+ * @param value The value to check.
+ * @returns {boolean} `true` if the value has a `then` function.
+ */
+declare function isPromise(value: unknown): value is Promise<unknown>;
 /**
  * Type guard to check if a value is a string that ends with '%'.
  * @param val The value to check.
@@ -338,7 +390,7 @@ declare function randId(): string;
  * @template K - The type of the key (must be a string).
  * @template V - The type of the value being stored.
  */
-declare class Registry<K extends string, V> {
+declare class Registry<K extends PropertyKey, V> {
     protected readonly items: Map<K, V>;
     /**
      * Registers an item with a specific key.
@@ -372,4 +424,4 @@ declare class Registry<K extends string, V> {
     clear(): void;
 }
 
-export { type AxiEngineConfig, type Constructor, type DataSink, type DataSource, type DataStorage, Emitter, type PathType, Registry, type ScalarType, type Subscribable, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNull, isNullOrUndefined, isNumber, isPercentageString, isScalar, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwError, throwIf, throwIfEmpty, unique };
+export { type AxiEngineConfig, type Constructor, type DataSink, type DataSource, type DataStorage, Emitter, type PathType, Registry, type ScalarType, type Subscribable, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isFunction, isNull, isNullOrUndefined, isNumber, isObject, isPercentageString, isPromise, isScalar, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwError, throwIf, throwIfEmpty, unique };

package/dist/index.d.ts

@@ -270,12 +270,64 @@ declare class Emitter<T extends any[]> implements Subscribable<T> {
  * @returns True if the value is a string, number, or boolean.
  */
 declare function isScalar(value: unknown): value is ScalarType;
-declare function isNullOrUndefined(val: unknown): val is null | undefined;
+/**
+* Type guard that checks if a value is `null`.
+* @param val The value to check.
+* @returns {boolean} `true` if the value is `null`, otherwise `false`.
+*/
+declare function isNull(val: unknown): val is null;
+/**
+* Type guard that checks if a value is `undefined`.
+* @param val The value to check.
+* @returns {boolean} `true` if the value is `undefined`, otherwise `false`.
+*/
 declare function isUndefined(val: unknown): val is undefined;
+/**
+ * Type guard that checks if a value is either `null` or `undefined`.
+ * @param val The value to check.
+ * @returns {boolean} `true` if the value is `null` or `undefined`, otherwise `false`.
+ */
+declare function isNullOrUndefined(val: unknown): val is null | undefined;
+/**
+* Type guard that checks if a value is a `number`.
+* @param val The value to check.
+* @returns {boolean} `true` if the value is a `number`, otherwise `false`.
+*/
 declare function isNumber(val: unknown): val is number;
+/**
+ * Type guard that checks if a value is a `boolean`.
+ * @param val The value to check.
+ * @returns {boolean} `true` if the value is a `boolean`, otherwise `false`.
+ */
 declare function isBoolean(val: unknown): val is boolean;
+/**
+ * Type guard that checks if a value is a `string`.
+ * @param val The value to check.
+ * @returns {boolean} `true` if the value is a `string`, otherwise `false`.
+ */
 declare function isString(val: unknown): val is string;
-declare function isNull(val: unknown): val is null;
+/**
+ * Check if a value is a plain object.
+ * Correctly handles `null` and arrays, returning `false` for them.
+ *
+ * @param value The value to check.
+ * @returns {boolean} `true` if the value is a non-null, non-array object.
+ */
+declare function isObject(value: unknown): value is Record<PropertyKey, unknown>;
+/**
+ * Type guard that checks if a value is a function.
+ *
+ * @param value The value to check.
+ * @returns {boolean} `true` if the value is a function.
+ */
+declare function isFunction(value: unknown): value is (...args: any[]) => any;
+/**
+ * Type guard that checks if a value is a Promise-like object.
+ *
+ * @param value The value to check.
+ * @returns {boolean} `true` if the value has a `then` function.
+ */
+declare function isPromise(value: unknown): value is Promise<unknown>;
 /**
  * Type guard to check if a value is a string that ends with '%'.
  * @param val The value to check.
@@ -338,7 +390,7 @@ declare function randId(): string;
  * @template K - The type of the key (must be a string).
  * @template V - The type of the value being stored.
  */
-declare class Registry<K extends string, V> {
+declare class Registry<K extends PropertyKey, V> {
     protected readonly items: Map<K, V>;
     /**
      * Registers an item with a specific key.
@@ -372,4 +424,4 @@ declare class Registry<K extends string, V> {
     clear(): void;
 }
 
-export { type AxiEngineConfig, type Constructor, type DataSink, type DataSource, type DataStorage, Emitter, type PathType, Registry, type ScalarType, type Subscribable, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNull, isNullOrUndefined, isNumber, isPercentageString, isScalar, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwError, throwIf, throwIfEmpty, unique };
+export { type AxiEngineConfig, type Constructor, type DataSink, type DataSource, type DataStorage, Emitter, type PathType, Registry, type ScalarType, type Subscribable, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isFunction, isNull, isNullOrUndefined, isNumber, isObject, isPercentageString, isPromise, isScalar, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwError, throwIf, throwIfEmpty, unique };

package/dist/index.js

@@ -34,10 +34,13 @@ __export(index_exports, {
   getRandomElement: () => getRandomElement,
   haveSameElements: () => haveSameElements,
   isBoolean: () => isBoolean,
+  isFunction: () => isFunction,
   isNull: () => isNull,
   isNullOrUndefined: () => isNullOrUndefined,
   isNumber: () => isNumber,
+  isObject: () => isObject,
   isPercentageString: () => isPercentageString,
+  isPromise: () => isPromise,
   isScalar: () => isScalar,
   isSequentialStart: () => isSequentialStart,
   isString: () => isString,
@@ -104,11 +107,14 @@ function isScalar(value) {
   const type = typeof value;
   return type === "string" || type === "number" || type === "boolean";
 }
-function isNullOrUndefined(val) {
-  return val === void 0 || val === null;
+function isNull(val) {
+  return val === null;
 }
 function isUndefined(val) {
-  return typeof val === "undefined";
+  return val === void 0;
+}
+function isNullOrUndefined(val) {
+  return val === null || val === void 0;
 }
 function isNumber(val) {
   return typeof val === "number";
@@ -119,8 +125,14 @@ function isBoolean(val) {
 function isString(val) {
   return typeof val === "string";
 }
-function isNull(val) {
-  return val === null;
+function isObject(value) {
+  return value !== null && !Array.isArray(value) && typeof value === "object";
+}
+function isFunction(value) {
+  return typeof value === "function";
+}
+function isPromise(value) {
+  return value != null && typeof value.then === "function";
 }
 function isPercentageString(val) {
   return typeof val === "string" && val.endsWith("%");
@@ -233,7 +245,7 @@ var Registry = class {
    * @param value The item to register.
    */
   register(key, value) {
-    throwIf(this.items.has(key), `An item with the key '${key}' is already registered and will be overwritten.`);
+    throwIf(this.items.has(key), `An item with the key '${String(key)}' is already registered and will be overwritten.`);
     this.items.set(key, value);
   }
   /**
@@ -259,7 +271,7 @@ var Registry = class {
    */
   getOrThrow(key) {
     const item = this.get(key);
-    throwIfEmpty(item, `No item registered for the key '${key}'.`);
+    throwIfEmpty(item, `No item registered for the key '${String(key)}'.`);
     return item;
   }
   delete(key) {
@@ -288,10 +300,13 @@ var Registry = class {
   getRandomElement,
   haveSameElements,
   isBoolean,
+  isFunction,
   isNull,
   isNullOrUndefined,
   isNumber,
+  isObject,
   isPercentageString,
+  isPromise,
   isScalar,
   isSequentialStart,
   isString,

package/dist/index.mjs

@@ -49,11 +49,14 @@ function isScalar(value) {
   const type = typeof value;
   return type === "string" || type === "number" || type === "boolean";
 }
-function isNullOrUndefined(val) {
-  return val === void 0 || val === null;
+function isNull(val) {
+  return val === null;
 }
 function isUndefined(val) {
-  return typeof val === "undefined";
+  return val === void 0;
+}
+function isNullOrUndefined(val) {
+  return val === null || val === void 0;
 }
 function isNumber(val) {
   return typeof val === "number";
@@ -64,8 +67,14 @@ function isBoolean(val) {
 function isString(val) {
   return typeof val === "string";
 }
-function isNull(val) {
-  return val === null;
+function isObject(value) {
+  return value !== null && !Array.isArray(value) && typeof value === "object";
+}
+function isFunction(value) {
+  return typeof value === "function";
+}
+function isPromise(value) {
+  return value != null && typeof value.then === "function";
 }
 function isPercentageString(val) {
   return typeof val === "string" && val.endsWith("%");
@@ -178,7 +187,7 @@ var Registry = class {
    * @param value The item to register.
    */
   register(key, value) {
-    throwIf(this.items.has(key), `An item with the key '${key}' is already registered and will be overwritten.`);
+    throwIf(this.items.has(key), `An item with the key '${String(key)}' is already registered and will be overwritten.`);
     this.items.set(key, value);
   }
   /**
@@ -204,7 +213,7 @@ var Registry = class {
    */
   getOrThrow(key) {
     const item = this.get(key);
-    throwIfEmpty(item, `No item registered for the key '${key}'.`);
+    throwIfEmpty(item, `No item registered for the key '${String(key)}'.`);
     return item;
   }
   delete(key) {
@@ -232,10 +241,13 @@ export {
   getRandomElement,
   haveSameElements,
   isBoolean,
+  isFunction,
   isNull,
   isNullOrUndefined,
   isNumber,
+  isObject,
   isPercentageString,
+  isPromise,
   isScalar,
   isSequentialStart,
   isString,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axi-engine/utils",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "description": "Core utility library for Axi Engine, providing common functions for arrays, math, type guards, and more.",
   "license": "MIT",
   "repository": {