@emrys-cloud/me-utils/core/types.d.ts

me-utils 是一个 基于 TypeScript 开发的、简易的、模块化的 JavaScript 实用工具库。

/**
 * @file 类型相关api
 */
/**
 * 判断值是否为 null
 * @param {unknown} value
 * @returns {value is null}
 *
 * @example
 * isNull(null) // => true
 * isNull('') // => false
 */
export declare const isNull: (value?: unknown) => value is null;
/**
 * 判断值是否为 undefined
 * @param {unknown} value
 * @returns {value is undefined}
 *
 * @example
 * isUndefined(undefined) // => true
 * isUndefined('') // => false
 */
export declare const isUndefined: (value?: unknown) => value is undefined;
/**
 * 判断值是否为 Number
 * @param {unknown} value
 * @returns {value is number}
 *
 * @example
 * isNumber(123) // => true
 * isNumber('') // => false
 */
export declare const isNumber: (value?: unknown) => value is number;
/**
 * 判断值是否为 Boolean
 * @param {unknown} value
 * @returns {value is boolean}
 *
 * @example
 * isBoolean(true) // => true
 * isBoolean(1) // => false
 */
export declare const isBoolean: (value?: unknown) => value is boolean;
/**
 * 判断值是否为 String
 * @param {unknown} value
 * @returns {value is string}
 *
 * @example
 * isString('1') // => true
 * isString(1) // => false
 */
export declare const isString: (value?: unknown) => value is string;
/**
 * 判断值是否为 Object
 * @param {unknown} value
 * @returns {value is object}
 *
 * @example
 * isObject({}) // => true
 * isObject(1) // => false
 */
export declare const isObject: <T extends Record<any, any>>(value?: unknown) => value is T;
/**
 * 判断值是否为 Array
 * @param {unknown} value
 * @returns {value is unknown[]}
 *
 * @example
 * isArray([]) // => true
 * isArray({}) // => false
 */
export declare const isArray: <T extends unknown[]>(value?: unknown) => value is T;
/**
 * 判断值是否为 Function
 * @param {unknown} value
 * @returns {value is Function}
 *
 * @example
 * isFunction(()=>{}) // => true
 * isFunction(1) // => false
 */
export declare const isFunction: (value?: unknown) => value is Function;
/**
 * 判断值是否为 Date
 * @param {unknown} value
 * @returns {value is Date}
 *
 * @example
 * isDate(new Date()) // => true
 * isDate(1123234234234) // => false
 */
export declare const isDate: (value?: unknown) => value is Date;
/**
 * 判断值是否为 正则 RegExp
 * @param {unknown} value
 * @returns {value is Date}
 *
 * @example
 * isRegExp(new RegExp()) // => true
 * isRegExp(/a-z/) // => true
 * isRegExp(1) // => false
 */
export declare const isRegExp: (value?: unknown) => value is RegExp;
/**
 * 判断值是否为 Symbol
 * @param {unknown} value
 * @returns {value is symbol}
 *
 * @example
 * isSymbol(Symbol()) // => true
 * isSymbol('') // => false
 */
export declare const isSymbol: (value?: unknown) => value is symbol;
/**
 * 判断值是否为一个可解析的JSON字符串
 * @param {unknown} value
 * @returns {value is string}
 *
 * @example
 * isJsonString('[]') // => true
 * isJsonString('') // => false
 */
export declare const isJsonString: (value?: unknown) => value is string;
/**
 * 判断值是否为空，包含 undefined、null、空字符串（只有空格的字符串）、空数组、空对象
 * @param {unknown} value 要判断的数据
 * @returns {value is void}
 *
 * @example
 * isEmpty('   ') // => true
 * isEmpty({}) // => true
 * isEmpty(0) // => false
 */
export declare const isEmpty: (value?: unknown) => value is void;
/**
 * 判断值是否不为空，与isEmpty取反
 * @param {unknown} value 要判断的数据
 * @returns {boolean}
 *
 * @example
 * isNotEmpty(0) // => true
 * isNotEmpty('   ') // => false
 * isNotEmpty({}) // => false
 */
export declare const isNotEmpty: <T>(value?: unknown) => value is T;