@creejs/commons-lang 1.0.3 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@creejs/commons-lang",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "description": "Commons Utils About Language",
   "main": "index.js",
   "private": false,
@@ -10,6 +10,7 @@
     "types/",
     "README.md"
   ],
+  "types": "types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },

package/types/lang-utils.d.ts

@@ -3,18 +3,18 @@
  * @description Language utility functions
  */
 /**
-   * Gets the constructor name of a value.
-   * @param {*} value - The value to check.
-   * @returns {string|undefined} The constructor name, or undefined if value has no constructor.
-   */
+ * Gets the constructor name of a value.
+ * @param {*} value - The value to check.
+ * @returns {string|undefined} The constructor name, or undefined if value has no constructor.
+ */
 export function constructorName(value: any): string | undefined;
 /**
-   * Assigns default values from source objects to target object for undefined properties.
-   * @param {Object<string, any>} target - The target object to assign defaults to
-   * @param {...Object<string, any>} sources - Source objects containing default values
-   * @returns {Object<string, any>} The modified target object with defaults applied
-   * @throws {TypeError} If target is null or undefined
-   */
+ * Assigns default values from source objects to target object for undefined properties.
+ * @param {Object<string, any>} target - The target object to assign defaults to
+ * @param {...Object<string, any>} sources - Source objects containing default values
+ * @returns {Object<string, any>} The modified target object with defaults applied
+ * @throws {TypeError} If target is null or undefined
+ */
 export function defaults(target: {
     [x: string]: any;
 }, ...sources: {
@@ -23,12 +23,12 @@ export function defaults(target: {
     [x: string]: any;
 };
 /**
-   * Extends a target object with properties from one or more source objects.
-   * @param {Object<string, any>} target - The target object to extend (must not be null/undefined)
-   * @param {...Object<string, any>} sources - One or more source objects to copy properties from
-   * @returns {Object<string, any>} The modified target object
-   * @throws {TypeError} If target is null or undefined
-   */
+ * Extends a target object with properties from one or more source objects.
+ * @param {Object<string, any>} target - The target object to extend (must not be null/undefined)
+ * @param {...Object<string, any>} sources - One or more source objects to copy properties from
+ * @returns {Object<string, any>} The modified target object
+ * @throws {TypeError} If target is null or undefined
+ */
 export function extend(target: {
     [x: string]: any;
 }, ...sources: {
@@ -37,22 +37,22 @@ export function extend(target: {
     [x: string]: any;
 };
 /**
-   * Compares two values for equality
-   * 1. First checks strict equality (===),
-   * 2. then checks if either value has an `equals` method and uses it.
-   * @param {*} value1 - First value to compare
-   * @param {*} value2 - Second value to compare
-   * @returns {boolean} True if values are equal, false otherwise
-   */
+ * Compares two values for equality
+ * 1. First checks strict equality (===),
+ * 2. then checks if either value has an `equals` method and uses it.
+ * @param {*} value1 - First value to compare
+ * @param {*} value2 - Second value to compare
+ * @returns {boolean} True if values are equal, false otherwise
+ */
 export function equals(value1: any, value2: any): boolean;
 /**
-   * Check if the current environment is a browser
-   * @returns {boolean}
-   */
+ * Check if the current environment is a browser
+ * @returns {boolean}
+ */
 export function isBrowser(): boolean;
 /**
-   * Check if the current environment is a nodejs
-   * @returns {boolean}
-   */
+ * Check if the current environment is a nodejs
+ * @returns {boolean}
+ */
 export function isNode(): boolean;
 export { extend as extends };

package/types/promise-utils.d.ts

@@ -2,23 +2,26 @@
  * Creates a "Deferred" Object with Timeout support
  * 1. timeout=-1, it means no timeout check
  * @param {number} [timeout=-1] - Timeout duration in milliseconds
+ * @param {string} [timeoutMessage]
  * @returns {{promise: Promise<*>, reject: function, resolve: function}}
  */
-export function defer(timeout?: number, timeoutMessage: any): {
+export function defer(timeout?: number, timeoutMessage?: string): {
     promise: Promise<any>;
     reject: Function;
     resolve: Function;
 };
 /**
-   * Delays the resolution or rejection of a promise by a specified time.
-   * Ensures the promise settles after at least the given milliseconds.
-   * If the original promise settles before the delay, waits for remaining time.
+   * Delays a promise by a specified time.
+   * 1. delay(), wait 1ms
+   * 2. delay(1000), wait 1000ms
+   * 3. delay(promise), after promise settled, wait 1000ms
+   * 4. delay(promise, 2000), after promise settled, wait 2000ms
    *
-   * @param {Promise} promise - The input promise to delay
-   * @param {number} [ms=1000] - Minimum delay in milliseconds (default: 1)
+   * @param {Promise<*>|number|undefined} [promise] - The input promise to delay
+   * @param {number|undefined} [ms] - Minimum delay in milliseconds (default: 1)
    * @returns {Promise} A new promise that settles after the delay period
    */
-export function delay(promise: Promise<any>, ms?: number): Promise<any>;
+export function delay(promise?: Promise<any> | number | undefined, ms?: number | undefined): Promise<any>;
 /**
  * Creates a timeout wrapper around a promise that rejects if the promise doesn't resolve within the given time.
  * @param {Promise<*>} promise - The promise to wrap with a timeout

package/types/type-assert.d.ts

@@ -1,91 +1,139 @@
 /**
    * if value is not a Number, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertNumber(value: any): void;
+export function assertNumber(value: any, paramName?: string): void;
+/**
+ * Asserts that a value is a positive number.
+ * @param {number} value - The value to check.
+ * @param {string} [paramName] - Optional name of the parameter for error message.
+ * @throws {Error} If the value is not a number or is less than or equal to zero.
+ */
+export function assertPositive(value: number, paramName?: string): void;
+/**
+ * Asserts that a value is a Negative number.
+ * @param {number} value - The value to check.
+ * @param {string} [paramName] - Optional name of the parameter for error message.
+ * @throws {Error} If the value is not a number or is less than or equal to zero.
+ */
+export function assertNegative(value: number, paramName?: string): void;
 /**
    * if value is not a string, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertBoolean(value: any): void;
+export function assertBoolean(value: any, paramName?: string): void;
 /**
    * if value is not a Object, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertObject(value: any): void;
+export function assertObject(value: any, paramName?: string): void;
 /**
    * if value is not a PlainObject, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertPlainObject(value: any): void;
+export function assertPlainObject(value: any, paramName?: string): void;
 /**
    * if value is not a Symbol, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check@param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertSymbol(value: any): void;
+export function assertSymbol(value: any, paramName?: string): void;
 /**
    * if value is not a Function, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertFunction(value: any): void;
+export function assertFunction(value: any, paramName?: string): void;
 /**
    * if value is not a Class instance, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertInstance(value: any): void;
+export function assertInstance(value: any, paramName?: string): void;
 /**
    * if value is not a string, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertPromise(value: any): void;
+export function assertPromise(value: any, paramName?: string): void;
 /**
    * if value is not a Null or Undefined, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertNil(value: any): void;
+export function assertNil(value: any, paramName?: string): void;
+/**
+ * Asserts that the given value is not nil.
+ * @param {*} value - The value to check
+ * @param {string} [paramName] - The name of the parameter to check
+ * @throws {Error} Throws an error if the value is nil
+ */
+export function assertNotNil(value: any, paramName?: string): void;
 /**
    * if value is not a Null, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertNull(value: any): void;
+export function assertNull(value: any, paramName?: string): void;
+/**
+ * Asserts that the given value is not null.
+ * @param {*} value - The value to check
+ * @param {string} [paramName] - The name of the parameter to check
+ * @throws {Error} Throws an error if the value is null
+ */
+export function assertNotNull(value: any, paramName?: string): void;
 /**
    * if value is not a Undefined, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertUndefined(value: any): void;
+export function assertUndefined(value: any, paramName?: string): void;
 /**
    * if value is not a string, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertString(value: any): void;
+export function assertString(value: any, paramName?: string): void;
 /**
    * if value is not Array, throw error
    * @param {*} value
+   * @param {string} [paramName] - The name of the parameter to check
    * @returns {void}
    * @throws {Error}
    */
-export function assertArray(value: any): void;
+export function assertArray(value: any, paramName?: string): void;
+/**
+ * Asserts that the given value is either a string or a symbol.
+ * @param {*} value - The value to check.
+ * @param {string} [paramName] - Optional parameter name for error message.
+ * @throws {Error} Throws an error if the value is not a string or symbol.
+ */
+export function assertStringOrSymbol(value: any, paramName?: string): void;

package/types/type-utils.d.ts

@@ -68,6 +68,17 @@ export function isWeakMap(value: any): boolean;
    * @returns {boolean} True if the value is a number, false otherwise.
    */
 export function isNumber(value: any): boolean;
+/**
+ * check that a value is a positive number.
+ * @param {number} value - The value to check.
+ * @returns {boolean}
+ */
+export function isPositive(value: number): boolean;
+/**
+ * check that a value is a Negative number.
+ * @param {number} value - The value to check.
+ */
+export function isNegative(value: number): boolean;
 /**
    * Checks if a value is null or undefined.
    * 1. value == null