UNPKG

@kitiumai/utils-ts

Version:

Comprehensive TypeScript utilities for KitiumAI projects

182 lines 4.01 kB
/** * Validation and type guard utilities */ /** * Check if value is a string * * @param value - The value to check * @returns True if value is a string * * @example * ```ts * isString('hello') // true * isString(123) // false * ``` */ export declare function isString(value: unknown): value is string; /** * Check if value is a number (and not NaN) * * @param value - The value to check * @returns True if value is a number * * @example * ```ts * isNumber(123) // true * isNumber(NaN) // false * isNumber('123') // false * ``` */ export declare function isNumber(value: unknown): value is number; /** * Check if value is a boolean * * @param value - The value to check * @returns True if value is a boolean * * @example * ```ts * isBoolean(true) // true * isBoolean(false) // true * isBoolean(0) // false * ``` */ export declare function isBoolean(value: unknown): value is boolean; /** * Check if value is an array * * @template T - The type of array elements * @param value - The value to check * @returns True if value is an array * * @example * ```ts * isArray([1, 2, 3]) // true * isArray('hello') // false * ``` */ export declare function isArray<T>(value: unknown): value is T[]; /** * Check if value is a plain object (not array, not null) * * @param value - The value to check * @returns True if value is a plain object * * @example * ```ts * isObject({}) // true * isObject([]) // false * isObject(null) // false * ``` */ export declare function isObject(value: unknown): value is object; /** * Check if value is a function * * @param value - The value to check * @returns True if value is a function * * @example * ```ts * isFunction(() => {}) // true * isFunction('hello') // false * ``` */ export declare function isFunction(value: unknown): value is Function; /** * Check if value is a Date instance * * @param value - The value to check * @returns True if value is a Date * * @example * ```ts * isDate(new Date()) // true * isDate('2024-01-01') // false * ``` */ export declare function isDate(value: unknown): value is Date; /** * Check if value is a RegExp instance * * @param value - The value to check * @returns True if value is a RegExp * * @example * ```ts * isRegExp(/test/) // true * isRegExp('test') // false * ``` */ export declare function isRegExp(value: unknown): value is RegExp; /** * Check if value is an Error instance * * @param value - The value to check * @returns True if value is an Error * * @example * ```ts * isError(new Error('test')) // true * isError('error') // false * ``` */ export declare function isError(value: unknown): value is Error; /** * Check if value is null or undefined * * @param value - The value to check * @returns True if value is null or undefined * * @example * ```ts * isNil(null) // true * isNil(undefined) // true * isNil(0) // false * ``` */ export declare function isNil(value: unknown): value is null | undefined; /** * Check if value is empty (null, undefined, empty array, empty string, or empty object) * * @param value - The value to check * @returns True if value is empty * * @example * ```ts * isEmpty(null) // true * isEmpty([]) // true * isEmpty('') // true * isEmpty({}) // true * isEmpty([1]) // false * ``` */ export declare function isEmpty(value: unknown): boolean; /** * Check if value is a finite number * * @param value - The value to check * @returns True if value is a finite number * * @example * ```ts * isFinite(123) // true * isFinite(Infinity) // false * isFinite(NaN) // false * ``` */ export declare function isFinite(value: unknown): value is number; /** * Check if value is an integer * * @param value - The value to check * @returns True if value is an integer * * @example * ```ts * isInteger(123) // true * isInteger(123.5) // false * ``` */ export declare function isInteger(value: unknown): value is number; //# sourceMappingURL=validation.d.ts.map