util-helpers 4.11.0 → 4.12.1

package/types/src/utils/type/isDate.d.ts

@@ -0,0 +1,18 @@
+export default isDate;
+/**
+ * 检查值是否为Date
+ *
+ * @static
+ * @alias module:Type.isDate
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为Date
+ * @example
+ *
+ * isDate(new Date)
+ * // => true
+ *
+ * isDate('Mon April 23 2012')
+ * // => false
+ */
+declare function isDate(value: any): boolean;

package/types/src/utils/type/isError.d.ts

@@ -0,0 +1,18 @@
+export default isError;
+/**
+ * 检查值是否为Error、EvalError、RangeError、ReferenceError、SyntaxError、TypeError、URIError|DOMException
+ *
+ * @static
+ * @alias module:Type.isError
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为Error、EvalError、RangeError、ReferenceError、SyntaxError、TypeError、URIError|DOMException
+ * @example
+ *
+ * isError(new Error)
+ * // => true
+ *
+ * isError(Error)
+ * // => false
+ */
+declare function isError(value: any): boolean;

package/types/src/utils/type/isFunction.d.ts

@@ -0,0 +1,18 @@
+export default isFunction;
+/**
+ * 检查值是否为Function|AsyncFunction|GeneratorFunction|Proxy
+ *
+ * @static
+ * @alias module:Type.isFunction
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为Function|AsyncFunction|GeneratorFunction|Proxy
+ * @example
+ *
+ * isFunction(()=>{}))
+ * // => true
+ *
+ * isFunction(/abc/)
+ * // => false
+ */
+declare function isFunction(value: any): boolean;

package/types/src/utils/type/isMap.d.ts

@@ -0,0 +1,18 @@
+export default isMap;
+/**
+ * 检查值是否为Map
+ *
+ * @static
+ * @alias module:Type.isMap
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为Map
+ * @example
+ *
+ * isMap(new Map)
+ * // => true
+ *
+ * isMap(new WeakMap)
+ * // => false
+ */
+declare function isMap(value: any): boolean;

package/types/src/utils/type/isNaN.d.ts

@@ -0,0 +1,18 @@
+export default _isNaN;
+/**
+ * 检查值是否为NaN
+ *
+ * @static
+ * @alias module:Type.isNaN
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为NaN
+ * @example
+ *
+ * isNaN(NaN)
+ * // => true
+ *
+ * isNaN(1)
+ * // => false
+ */
+declare function _isNaN(value: any): boolean;

package/types/src/utils/type/isNil.d.ts

@@ -0,0 +1,11 @@
+export default isNil;
+/**
+ * 检查值是否为 undefined 或 null
+ *
+ * @static
+ * @alias module:Type.isNaN
+ * @since 4.3.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为 undefined 或 null
+ */
+declare function isNil(value: any): boolean;

package/types/src/utils/type/isNull.d.ts

@@ -0,0 +1,18 @@
+export default isNull;
+/**
+ * 检查值是否为Null
+ *
+ * @static
+ * @alias module:Type.isNull
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为Null
+ * @example
+ *
+ * isNull(null)
+ * // => true
+ *
+ * isNull(void 0)
+ * // => false
+ */
+declare function isNull(value: any): boolean;

package/types/src/utils/type/isNumber.d.ts

@@ -0,0 +1,27 @@
+export default isNumber;
+/**
+ * 检查值是否为Number
+ *
+ * @static
+ * @alias module:Type.isNumber
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为Number
+ * @example
+ *
+ * isNumber(1)
+ * // => true
+ *
+ * isNumber(Number.MIN_VALUE)
+ * // => true
+ *
+ * isNumber(Infinity)
+ * // => true
+ *
+ * isNumber(NaN)
+ * // => true
+ *
+ * isNumber('1')
+ * // => false
+ */
+declare function isNumber(value: any): boolean;

package/types/src/utils/type/isObject.d.ts

@@ -0,0 +1,21 @@
+export default isObject;
+/**
+ * 检查值是否为Object
+ *
+ * @static
+ * @alias module:Type.isObject
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为Object
+ * @example
+ *
+ * isObject({})
+ * // => true
+ *
+ * isObject([1,2,3])
+ * // => true
+ *
+ * isObject(null)
+ * // => false
+ */
+declare function isObject(value: any): boolean;

package/types/src/utils/type/isRegExp.d.ts

@@ -0,0 +1,18 @@
+export default isRegExp;
+/**
+ * 检查值是否为RegExp
+ *
+ * @static
+ * @alias module:Type.isRegExp
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为RegExp
+ * @example
+ *
+ * isRegExp(/abc/)
+ * // => true
+ *
+ * isRegExp('/abc/')
+ * // => false
+ */
+declare function isRegExp(value: any): boolean;

package/types/src/utils/type/isSet.d.ts

@@ -0,0 +1,18 @@
+export default isSet;
+/**
+ * 检查值是否为Set
+ *
+ * @static
+ * @alias module:Type.isSet
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为Set
+ * @example
+ *
+ * isSet(new Set)
+ * // => true
+ *
+ * isSet(new WeakSet)
+ * // => false
+ */
+declare function isSet(value: any): boolean;

package/types/src/utils/type/isString.d.ts

@@ -0,0 +1,18 @@
+export default isString;
+/**
+ * 检查值是否为String
+ *
+ * @static
+ * @alias module:Type.isString
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为String
+ * @example
+ *
+ * isString('abc')
+ * // => true
+ *
+ * isString(1)
+ * // => false
+ */
+declare function isString(value: any): boolean;

package/types/src/utils/type/isSymbol.d.ts

@@ -0,0 +1,18 @@
+export default isSymbol;
+/**
+ * 检查值是否为Symbol
+ *
+ * @static
+ * @alias module:Type.isSymbol
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为Symbol
+ * @example
+ *
+ * isSymbol(Symbol.iterator)
+ * // => true
+ *
+ * isSymbol("abc")
+ * // => false
+ */
+declare function isSymbol(value: any): boolean;

package/types/src/utils/type/isType.d.ts

@@ -0,0 +1,11 @@
+export default isType;
+/**
+ * 检测值的 `toString` 类型
+ *
+ * @private
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @param {string} typename 类型名称
+ * @returns {boolean} 返回值的 `toString` 类型是否匹配
+ */
+declare function isType(value: any, typename: string): boolean;

package/types/src/utils/type/isUndefined.d.ts

@@ -0,0 +1,21 @@
+export default isUndefined;
+/**
+ * 检查值是否为Undefined
+ *
+ * @static
+ * @alias module:Type.isUndefined
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为Undefined
+ * @example
+ *
+ * isUndefined(undefined)
+ * // => true
+ *
+ * isUndefined(void 0)
+ * // => true
+ *
+ * isUndefined(null)
+ * // => false
+ */
+declare function isUndefined(value: any): boolean;

package/types/src/utils/type/isWeakMap.d.ts

@@ -0,0 +1,18 @@
+export default isWeakMap;
+/**
+ * 检查值是否为WeakMap
+ *
+ * @static
+ * @alias module:Type.isWeakMap
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为WeakMap
+ * @example
+ *
+ * isWeakMap(new WeakMap)
+ * // => true
+ *
+ * isWeakMap(new Map)
+ * // => false
+ */
+declare function isWeakMap(value: any): boolean;

package/types/src/utils/type/isWeakSet.d.ts

@@ -0,0 +1,18 @@
+export default isWeakSet;
+/**
+ * 检查值是否为WeakSet
+ *
+ * @static
+ * @alias module:Type.isWeakSet
+ * @since 1.1.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为WeakSet
+ * @example
+ *
+ * isWeakSet(new WeakSet)
+ * // => true
+ *
+ * isWeakSet(new Set)
+ * // => false
+ */
+declare function isWeakSet(value: any): boolean;

package/types/src/validatePassword.d.ts

@@ -0,0 +1,134 @@
+export default validatePassword;
+/**
+ * - 验证密码的包含内容
+ */
+export type PasswordContaines = {
+    /**
+     * - 包含数字
+     */
+    number: boolean;
+    /**
+     * - 包含小写字母
+     */
+    lowerCaseLetter: boolean;
+    /**
+     * - 包含大写字母
+     */
+    upperCaseLetter: boolean;
+    /**
+     * - 包含特殊字符
+     */
+    specialCharacter: boolean;
+    /**
+     * - 包含非法字符
+     */
+    unallowableCharacter: boolean;
+};
+/**
+ * - 验证结果
+ */
+export type ValidatePasswordReturn = {
+    /**
+     * - 验证结果，根据密码强度、是否包含非法字符得出
+     */
+    validated: boolean;
+    /**
+     * - 强度级别，包含数字/大小写字母/特殊字符
+     */
+    level: number;
+    /**
+     * - 包含内容
+     */
+    containes: PasswordContaines;
+};
+/**
+ * @typedef {Object} PasswordContaines - 验证密码的包含内容
+ * @property {boolean} number - 包含数字
+ * @property {boolean} lowerCaseLetter - 包含小写字母
+ * @property {boolean} upperCaseLetter - 包含大写字母
+ * @property {boolean} specialCharacter - 包含特殊字符
+ * @property {boolean} unallowableCharacter - 包含非法字符
+ */
+/**
+ * @typedef {Object} ValidatePasswordReturn - 验证结果
+ * @property {boolean} validated - 验证结果，根据密码强度、是否包含非法字符得出
+ * @property {number} level - 强度级别，包含数字/大小写字母/特殊字符
+ * @property {PasswordContaines} containes - 包含内容
+ */
+/**
+ * 验证密码（数字、大小写字母、特殊字符、非法字符）
+ *
+ * @see 参考 {@link https://baike.baidu.com/item/ASCII#3|ASCII}
+ * @static
+ * @alias module:Validator.validatePassword
+ * @since 3.7.0
+ * @param {string} value 要检测的值
+ * @param {Object} [options] 配置项
+ * @param {number} [options.level=2] 密码强度 1-包含一种字符 2-包含两种字符 3-包含三种字符。（大写字母、小写字母、数字、特殊字符）
+ * @param {boolean} [options.ignoreCase=false] 是否忽略大小写，为 ture 时，大小写字母视为一种字符
+ * @param {string} [options.special="!@#$%^&*()-=_+[]\|{},./?<>~"] 支持的特殊字符
+ * @returns {ValidatePasswordReturn} 验证结果
+ * @example
+ *
+ * validatePassword('a12345678');
+ * // =>
+ * {
+ *   validated: true, // 验证结果，根据密码强度、是否包含非法字符得出
+ *   level: 2, // 强度级别
+ *   containes: {
+ *     number: true, // 包含数字
+ *     lowerCaseLetter: true, // 包含小写字母
+ *     upperCaseLetter: false, // 包含大写字母
+ *     specialCharacter: false, // 包含特殊字符
+ *     unallowableCharacter: false // 包含非法字符
+ *   }
+ * }
+ *
+ * validatePassword('a12345678', { level: 3 });
+ * // =>
+ * {
+ *   validated: false,
+ *   level: 2,
+ *   containes: {
+ *     number: true,
+ *     lowerCaseLetter: true,
+ *     upperCaseLetter: false,
+ *     specialCharacter: false,
+ *     unallowableCharacter: false
+ *   }
+ * }
+ *
+ * validatePassword('_Aa一二三45678', { level: 3, ignoreCase: true });
+ * // =>
+ * {
+ *   validated: false,
+ *   level: 3,
+ *   containes: {
+ *     number: true,
+ *     lowerCaseLetter: true,
+ *     upperCaseLetter: true,
+ *     specialCharacter: true,
+ *     unallowableCharacter: true
+ *   }
+ * }
+ *
+ * // 自定义特殊字符
+ * validatePassword('_Aa一二三45678', { level: 3, ignoreCase: true, special: '_一二三' });
+ * // =>
+ * {
+ *   validated: true,
+ *   level: 3,
+ *   containes: {
+ *     number: true,
+ *     lowerCaseLetter: true,
+ *     upperCaseLetter: true,
+ *     specialCharacter: true,
+ *     unallowableCharacter: false
+ *   }
+ * }
+ */
+declare function validatePassword(value: string, { level, ignoreCase, special }?: {
+    level?: number | undefined;
+    ignoreCase?: boolean | undefined;
+    special?: string | undefined;
+} | undefined): ValidatePasswordReturn;

package/types/src/waitTime.d.ts

@@ -0,0 +1,20 @@
+export default waitTime;
+/**
+ * 等待时间返回 Promise 。常用于异步方法中延时。
+ *
+ * @static
+ * @alias module:Other.waitTime
+ * @since 4.2.0
+ * @param {number} [time=1000] 延时时间，单位毫秒
+ * @returns {Promise<void>}
+ * @example
+ * const test = async ()=>{
+ *   await waitTime();
+ *   // do something
+ * }
+ *
+ * waitTime(500).then(()=>{
+ *   // do something
+ * })
+ */
+declare function waitTime(time?: number | undefined): Promise<void>;

package/types/utils/math.util.d.ts

@@ -1,3 +1,10 @@
+/**
+ * 值是否为有效的数值
+ *
+ * @param {*} value 待检测的值
+ * @returns {boolean} 是否为有效的数值
+ */
+export function isEffectiveNumeric(value: any): boolean;
 /**
  * 是否为科学计数法数字
  *