petite-utils
Version:
A collection of small util function in JavaScript.
132 lines (131 loc) • 3.15 kB
TypeScript
/**
* @group 类型检查
* @param {any} value 需要检查类型的值
* @returns {string} 返回类型的小写字符串
*/
declare function type(value: any): string;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isObject(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isPrimitive(value: any): boolean;
/**
* @group 类型检查
* @param e
* @returns
*/
declare function isError(e: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isDate(d: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isArray(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isBoolean(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isNull(value: any): boolean;
/**
* @group 类型检查
* @description 检查是否为 null 或者 undefined
* @param value
* @returns
*/
declare function isNullish(value: any): boolean;
/**
* @group 类型检查
* @description 检查给定的值是否为数字 是 number 或 bigint,则返回 true,否则返回 false
* @param value - 要检查的值,可以是任何类型
* @return 如果是数字或 BigInt,则返回 true,否则返回 false
*/
declare function isNumber(value: any): boolean;
/**
* @group 类型检查
* @description 检查给定的值是否为数值,包括数字、字符串数字 和 BigInt
* 此外,如果给定值是一个非空字符串,它将尝试将其转换为数字并检查其有效性
* @param value - 要检查的值,可以是任何类型
* @return 如果是数字或可转换为有效数字的字符串,则返回 true,否则返回 false
*/
declare function isNumerical(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isString(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isEmptyStr(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isSymbol(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isUndefined(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isRegExp(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isFalsy(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isFalsyNon0(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isTruthy(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isFunction(value: any): boolean;
/**
* @group 类型检查
* @param value
* @returns
*/
declare function isEmpty(value: any): boolean;
export { type, isObject, isArray, isBoolean, isDate, isError, isNull, isUndefined, isNullish, isNumber, isNumerical, isString, isSymbol, isRegExp, isPrimitive, isFalsy, isFalsyNon0, isTruthy, isFunction, isEmptyStr, isEmpty, };