@creejs/commons-lang 1.0.1

package/types/type-assert.d.ts

@@ -0,0 +1,91 @@
+/**
+   * if value is not a Number, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertNumber(value: any): void;
+/**
+   * if value is not a string, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertBoolean(value: any): void;
+/**
+   * if value is not a Object, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertObject(value: any): void;
+/**
+   * if value is not a PlainObject, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertPlainObject(value: any): void;
+/**
+   * if value is not a Symbol, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertSymbol(value: any): void;
+/**
+   * if value is not a Function, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertFunction(value: any): void;
+/**
+   * if value is not a Class instance, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertInstance(value: any): void;
+/**
+   * if value is not a string, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertPromise(value: any): void;
+/**
+   * if value is not a Null or Undefined, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertNil(value: any): void;
+/**
+   * if value is not a Null, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertNull(value: any): void;
+/**
+   * if value is not a Undefined, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertUndefined(value: any): void;
+/**
+   * if value is not a string, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertString(value: any): void;
+/**
+   * if value is not Array, throw error
+   * @param {*} value
+   * @returns {void}
+   * @throws {Error}
+   */
+export function assertArray(value: any): void;

package/types/type-asset.d.ts

@@ -0,0 +1,84 @@
+/**
+ * if value is not a string, throw error
+ * @param {*} value
+ * @returns {void}
+ * @throws {Error}
+ */
+export function assertString(value: any): void;
+/**
+ * if value is not a Number, throw error
+ * @param {*} value
+ * @returns {void}
+ * @throws {Error}
+ */
+export function assertNumber(value: any): void;
+/**
+ * if value is not a string, throw error
+ * @param {*} value
+ * @returns {void}
+ * @throws {Error}
+ */
+export function assertBoolean(value: any): void;
+/**
+ * if value is not a Object, throw error
+ * @param {*} value
+ * @returns {void}
+ * @throws {Error}
+ */
+export function assertObject(value: any): void;
+/**
+ * if value is not a PlainObject, throw error
+ * @param {*} value
+ * @returns {void}
+ * @throws {Error}
+ */
+export function assertPlainObject(value: any): void;
+/**
+ * if value is not a Symbol, throw error
+ * @param {*} value
+ * @returns {void}
+ * @throws {Error}
+ */
+export function assertSymbol(value: any): void;
+/**
+ * if value is not a Function, throw error
+ * @param {*} value
+ * @returns {void}
+ * @throws {Error}
+ */
+export function assertFunction(value: any): void;
+/**
+ * if value is not a Class instance, throw error
+ * @param {*} value
+ * @returns {void}
+ * @throws {Error}
+ */
+export function assertInstance(value: any): void;
+/**
+ * if value is not a string, throw error
+ * @param {*} value
+ * @returns {void}
+ * @throws {Error}
+ */
+export function assertPromise(value: any): void;
+/**
+ * if value is not a Null or Undefined, throw error
+ * @param {*} value
+ * @returns {void}
+ * @throws {Error}
+ */
+export function assertNil(value: any): void;
+/**
+ * if value is not a Null, throw error
+ * @param {*} value
+ * @returns {void}
+ * @throws {Error}
+ */
+export function assertNull(value: any): void;
+/**
+ * if value is not a Undefined, throw error
+ * @param {*} value
+ * @returns {void}
+ * @throws {Error}
+ */
+export function assertUndefined(value: any): void;

package/types/type-utils.d.ts

@@ -0,0 +1,158 @@
+/**
+ * @module TypeUtils
+ * @description Utility functions for type checking and validation.
+ */
+/**
+   * Checks if the given value is an array.
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is an array, false otherwise.
+   */
+export function isArray(value: any): boolean;
+/**
+   * Checks if the given value is a boolean.
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is a boolean, false otherwise.
+   */
+export function isBoolean(value: any): boolean;
+/**
+   * Checks if the given value is a Buffer.
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is a Buffer, false otherwise.
+   */
+export function isBuffer(value: any): boolean;
+/**
+   * Checks if the given value is a function.
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is a function, false otherwise.
+   */
+export function isFunction(value: any): boolean;
+/**
+   * Checks if a value is a class instance (non-null and not a plain object).
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is a class instance, false otherwise.
+   */
+export function isInstance(value: any): boolean;
+/**
+   * Checks if a value is isIterable
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is isIterable, false otherwise.
+   */
+export function isIterable(value: any): boolean;
+/**
+   * Checks if the given value is a Date.
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is a Date, false otherwise.
+   */
+export function isDate(value: any): boolean;
+/**
+   * Checks if the given value is an instance of Error.
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is an Error, false otherwise.
+   */
+export function isError(value: any): boolean;
+/**
+   * Checks if a value is Map
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is Map, otherwise false.
+   */
+export function isMap(value: any): boolean;
+/**
+   * Checks if a value is WeakMap
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is WeakMap, otherwise false.
+   */
+export function isWeakMap(value: any): boolean;
+/**
+   * Checks if a value is a number.
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is a number, false otherwise.
+   */
+export function isNumber(value: any): boolean;
+/**
+   * Checks if a value is null or undefined.
+   * 1. value == null
+   * 2. return true, if value is null or undefined
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is null or undefined, otherwise false.
+   */
+export function isNil(value: any): boolean;
+/**
+   * Checks if a value is null or undefined.
+   * 1. same with isNil()
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is null or undefined, otherwise false.
+   */
+export function isNullOrUndefined(value: any): boolean;
+/**
+   * Checks if the given value is exactly null.
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is null, false otherwise.
+   */
+export function isNull(value: any): boolean;
+/**
+   * Checks if a value is exactly undefined.
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is undefined, false otherwise.
+   */
+export function isUndefined(value: any): boolean;
+/**
+   * Checks if a value is a plain object (created by the Object constructor).
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is a plain object, false otherwise.
+   */
+export function isPlainObject(value: any): boolean;
+/**
+   * Checks if a value is an object (and not null).
+   * @param {*} value - The value to check
+   * @returns {boolean} True if the value is an object (not null), false otherwise
+   */
+export function isObject(value: any): boolean;
+/**
+   * Checks if a value is a Promise.
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is a Promise, false otherwise.
+   */
+export function isPromise(value: any): boolean;
+/**
+   * Checks if a RegExp
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is RegExp, otherwise false.
+   */
+export function isRegExp(value: any): boolean;
+/**
+   * Checks if a Set
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is Set, otherwise false.
+   */
+export function isSet(value: any): boolean;
+/**
+   * Checks if a WeakSet
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is WeakSet, otherwise false.
+   */
+export function isWeakSet(value: any): boolean;
+/**
+   * Check if the value is a string
+   * @param {*} value
+   * @return {boolean}
+   */
+export function isStream(value: any): boolean;
+/**
+   * Check if the value is a string
+   * @param {*} value
+   * @return {boolean}
+   */
+export function isString(value: any): boolean;
+/**
+   * Checks if the given value is a Symbol.
+   * @param {*} value - The value to check.
+   * @returns {boolean} True if the value is a Symbol, false otherwise.
+   */
+export function isSymbol(value: any): boolean;
+/**
+   * check if value is primitive: string, number, boolean
+   * 1. null/undefined returns false
+   * @param {*} value
+   * @returns {boolean}
+   */
+export function isPrimitive(value: any): boolean;