util-helpers 4.16.2 → 4.17.1

package/types/isChinese.d.ts

@@ -1,13 +1,16 @@
-export default isChinese;
+type Options = {
+    loose?: boolean;
+    useExtend?: boolean;
+};
 /**
  * 检测值是否为中文
  *
  * @static
  * @alias module:Validator.isChinese
  * @since 1.1.0
- * @see {@link http://www.unicode.org/reports/tr38/#BlockListing|4.4 Listing of Characters Covered by the Unihan Database}
- * @see {@link https://zh.wikipedia.org/wiki/Unicode字符平面映射|Unicode字符平面映射}
- * @see {@link https://zh.wikipedia.org/wiki/Unicode區段|Unicode区段}
+ * @see {@link http://www.unicode.org/reports/tr38/#BlockListing | 4.4 Listing of Characters Covered by the Unihan Database}
+ * @see {@link https://zh.wikipedia.org/wiki/Unicode字符平面映射 | Unicode字符平面映射}
+ * @see {@link https://zh.wikipedia.org/wiki/Unicode區段 | Unicode区段}
  * @param {*} value 要检测的值
  * @param {Object} [options] 配置项
  * @param {boolean} [options.loose=false] 宽松模式。如果为true，只要包含中文即为true
@@ -30,7 +33,5 @@ export default isChinese;
  * isChinese('𠮷aa', { useExtend: true, loose: true }); // true
  *
  */
-declare function isChinese(value: any, options?: {
-    loose?: boolean | undefined;
-    useExtend?: boolean | undefined;
-} | undefined): boolean;
+declare function isChinese(value: any, options?: Options): boolean;
+export default isChinese;

package/types/isEmail.d.ts

@@ -1,4 +1,3 @@
-export default isEmail;
 /**
  * 检测值是否为Email
  *
@@ -14,3 +13,4 @@ export default isEmail;
  *
  */
 declare function isEmail(value: any): boolean;
+export default isEmail;

package/types/isHMCard.d.ts

@@ -1,11 +1,10 @@
-export default isHMCard;
 /**
  * 检测值是否为港澳居民来往内地通行证，俗称回乡证或回乡卡。
  *
  * @static
  * @alias module:Validator.isHMCard
  * @since 4.0.0
- * @see {@link https://zh.wikipedia.org/wiki/港澳居民来往内地通行证|港澳居民来往内地通行证}
+ * @see {@link https://zh.wikipedia.org/wiki/港澳居民来往内地通行证 | 港澳居民来往内地通行证}
  * @param {*} value 要检测的值
  * @returns {boolean} 是否为港澳居民来往内地通行证
  * @example
@@ -22,3 +21,4 @@ export default isHMCard;
  * isHMCard('M32031177'); // true
  */
 declare function isHMCard(value: any): boolean;
+export default isHMCard;

package/types/isIPv4.d.ts

@@ -1,4 +1,3 @@
-export default isIPv4;
 /**
  * 检测值是否为ipv4
  *
@@ -16,3 +15,4 @@ export default isIPv4;
  *
  */
 declare function isIPv4(value: any): boolean;
+export default isIPv4;

package/types/isIPv6.d.ts

@@ -1,4 +1,3 @@
-export default isIPv6;
 /**
  * 检测值是否为ipv6
  *
@@ -30,3 +29,4 @@ export default isIPv6;
  *
  */
 declare function isIPv6(value: any): boolean;
+export default isIPv6;

package/types/isIdCard.d.ts

@@ -1,12 +1,15 @@
-export default isIdCard;
+type Options = {
+    loose?: boolean;
+    checkCode?: boolean;
+};
 /**
  * 检测值是否为18位身份证号码。<br/>宽松模式下，支持15位身份证号码
  *
  * @static
  * @alias module:Validator.isIdCard
  * @since 1.1.0
- * @see {@link https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码|中华人民共和国公民身份号码}
- * @see {@link https://baike.baidu.com/item/居民身份证号码|居民身份证号码}
+ * @see {@link https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码 | 中华人民共和国公民身份号码}
+ * @see {@link https://baike.baidu.com/item/居民身份证号码 | 居民身份证号码}
  * @param {*} value 要检测的值
  * @param {Object} [options] 配置项
  * @param {boolean} [options.loose=false] 宽松模式，支持15位身份证号码
@@ -27,7 +30,5 @@ export default isIdCard;
  * isIdCard('320311770706001', { loose: true }); // true
  *
  */
-declare function isIdCard(value: any, options?: {
-    loose?: boolean | undefined;
-    checkCode?: boolean | undefined;
-} | undefined): boolean;
+declare function isIdCard(value: any, options?: Options): boolean;
+export default isIdCard;

package/types/isMobile.d.ts

@@ -1,4 +1,3 @@
-export default isMobile;
 /**
  * 检测值是否为手机号码
  *
@@ -14,3 +13,4 @@ export default isMobile;
  *
  */
 declare function isMobile(value: any): boolean;
+export default isMobile;

package/types/isPassport.d.ts

@@ -1,4 +1,3 @@
-export default isPassport;
 /**
  * 检测值是否为护照号
  * 支持普通护照(E*)、外交护照(DE)、公务护照(SE)、公务普通护照(PE)、香港特区护照(K/KJ/H*)、澳门特区护照(MA/MB/M*)，注意不区分大小写
@@ -6,7 +5,7 @@ export default isPassport;
  * @static
  * @alias module:Validator.isPassport
  * @since 1.1.0
- * @see {@link https://zh.wikipedia.org/wiki/中华人民共和国护照#个人资料页|中华人民共和国护照#个人资料页}
+ * @see {@link https://zh.wikipedia.org/wiki/中华人民共和国护照#个人资料页 | 中华人民共和国护照#个人资料页}
  * @param {*} value 要检测的值
  * @returns {boolean} 值是否为护照号
  * @example
@@ -16,3 +15,4 @@ export default isPassport;
  *
  */
 declare function isPassport(value: any): boolean;
+export default isPassport;

package/types/isPassword.d.ts

@@ -1,4 +1,4 @@
-export default isPassword;
+import validatePassword from './validatePassword';
 /**
  * 检测值是否符合密码强度
  * <p><strong>注意：该校验只校验是否存在不同字符(大小写字母、数字、特殊符号)，不判断长度。</strong></p>
@@ -8,7 +8,7 @@ export default isPassword;
  * @alias module:Validator.isPassword
  * @requires module:Validator.validatePassword
  * @since 1.1.0
- * @see {@link https://baike.baidu.com/item/ASCII#3|ASCII}
+ * @see {@link https://baike.baidu.com/item/ASCII#3 | ASCII}
  * @param {*} value 要检测的值
  * @param {Object} [options] 配置项
  * @param {number} [options.level=2] 密码强度 1-包含一种字符 2-包含两种字符 3-包含三种字符。（大写字母、小写字母、数字、特殊字符）
@@ -32,8 +32,5 @@ export default isPassword;
  * isPassword(' _Aa12345678', {level: 3, ignoreCase: true}); // false
  *
  */
-declare function isPassword(value: any, options?: {
-    level?: number | undefined;
-    ignoreCase?: boolean | undefined;
-    special?: string | undefined;
-} | undefined): boolean;
+declare function isPassword(value: any, options?: Parameters<typeof validatePassword>[1]): boolean;
+export default isPassword;

package/types/isPostcode.d.ts

@@ -1,4 +1,3 @@
-export default isPostcode;
 /**
  * 检测值是否为邮政编码，6位数字
  *
@@ -14,3 +13,4 @@ export default isPostcode;
  *
  */
 declare function isPostcode(value: any): boolean;
+export default isPostcode;

package/types/isPromiseLike.d.ts

@@ -1,4 +1,3 @@
-export default isPromiseLike;
 /**
  * 检测值是否类似Promise对象
  *
@@ -15,3 +14,4 @@ export default isPromiseLike;
  *
  */
 declare function isPromiseLike(obj: any): boolean;
+export default isPromiseLike;

package/types/isQQ.d.ts

@@ -1,4 +1,3 @@
-export default isQQ;
 /**
  * 检测值是否为QQ号，非0开头，5至11位数字
  *
@@ -14,3 +13,4 @@ export default isQQ;
  *
  */
 declare function isQQ(value: any): boolean;
+export default isQQ;

package/types/isSocialCreditCode.d.ts

@@ -1,11 +1,15 @@
-export default isSocialCreditCode;
+type Options = {
+    /** @deprecated */
+    loose?: boolean;
+    checkCode?: boolean;
+};
 /**
  * 检测值是否为统一社会信用代码，也叫三证合一组织代码。由18位数字和大写字母组成，不使用I、O、Z、S、V。
  *
  * @static
  * @alias module:Validator.isSocialCreditCode
  * @since 1.1.0
- * @see {@link https://zh.wikisource.org/zh-hans/GB_32100-2015_法人和其他组织统一社会信用代码编码规则|GB 32100-2015 法人和其他组织统一社会信用代码编码规则}
+ * @see {@link https://zh.wikisource.org/zh-hans/GB_32100-2015_法人和其他组织统一社会信用代码编码规则 | GB 32100-2015 法人和其他组织统一社会信用代码编码规则}
  * @param {*} value 要检测的值
  * @param {Object} [options] 配置项
  * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，如果为false，不校验校验位。
@@ -21,6 +25,5 @@ export default isSocialCreditCode;
  * isSocialCreditCode('91350100M000100Y', { checkCode: false }); // false
  *
  */
-declare function isSocialCreditCode(value: any, options?: {
-    checkCode?: boolean | undefined;
-} | undefined): boolean;
+declare function isSocialCreditCode(value: any, options?: Options): boolean;
+export default isSocialCreditCode;

package/types/isSwiftCode.d.ts

@@ -1,11 +1,10 @@
-export default isSwiftCode;
 /**
  * 检测值是否为 Swift Code。8位或11位，前6位为大写字母，7-8位为大写字母或数字，9-11位为可选的大写字母或数字。
  *
  * @static
  * @alias module:Validator.isSwiftCode
  * @since 4.9.0
- * @see {@link https://zh.wikipedia.org/wiki/ISO_9362|ISO 9362}
+ * @see {@link https://zh.wikipedia.org/wiki/ISO_9362 | ISO 9362}
  * @param {*} value 要检测的值
  * @returns {boolean} 值是否为 Swift Code
  * @example
@@ -20,3 +19,4 @@ export default isSwiftCode;
  *
  */
 declare function isSwiftCode(value: any): boolean;
+export default isSwiftCode;

package/types/isTWCard.d.ts

@@ -1,11 +1,13 @@
-export default isTWCard;
+type Options = {
+    loose?: boolean;
+};
 /**
  * 检测值是否为台湾居民来往大陆通行证，俗称台胞证。
  *
  * @static
  * @alias module:Validator.isTWCard
  * @since 4.0.0
- * @see {@link https://zh.wikipedia.org/wiki/台湾居民来往大陆通行证|台湾居民来往大陆通行证}
+ * @see {@link https://zh.wikipedia.org/wiki/台湾居民来往大陆通行证 | 台湾居民来往大陆通行证}
  * @param {*} value 要检测的值
  * @param {Object} [options] 配置项
  * @param {boolean} [options.loose=false] 宽松模式。如果为true，表示支持一次性短期通行证
@@ -21,6 +23,5 @@ export default isTWCard;
  * // 宽松模式，支持一次性短期通行证
  * isTWCard('F290299977', { loose: true }); // true
  */
-declare function isTWCard(value: any, options?: {
-    loose?: boolean | undefined;
-} | undefined): boolean;
+declare function isTWCard(value: any, options?: Options): boolean;
+export default isTWCard;

package/types/isTelephone.d.ts

@@ -1,4 +1,3 @@
-export default isTelephone;
 /**
  * 检测值是否为固定电话
  *
@@ -20,3 +19,4 @@ export default isTelephone;
  *
  */
 declare function isTelephone(value: any): boolean;
+export default isTelephone;

package/types/isUrl.d.ts

@@ -1,11 +1,10 @@
-export default isUrl;
 /**
  * 检测值是否为url
  *
  * @static
  * @alias module:Validator.isUrl
  * @since 3.4.0
- * @see {@link https://zh.wikipedia.org/wiki/统一资源定位符|统一资源定位符}
+ * @see {@link https://zh.wikipedia.org/wiki/统一资源定位符 | 统一资源定位符}
  * @param {*} value 要检测的值
  * @returns {boolean} 值是否为url
  * @example
@@ -31,3 +30,4 @@ export default isUrl;
  *
  */
 declare function isUrl(value: any): boolean;
+export default isUrl;

package/types/isVehicle.d.ts

@@ -1,11 +1,10 @@
-export default isVehicle;
 /**
  * 检测值是否为车牌号，支持新能源和非新能源车牌
  *
  * @static
  * @alias module:Validator.isVehicle
  * @since 1.1.0
- * @see {@link https://baike.baidu.com/item/车牌号|车牌号}
+ * @see {@link https://baike.baidu.com/item/车牌号 | 车牌号}
  * @param {*} value 要检测的值
  * @returns {boolean} 值是否为车牌号
  * @example
@@ -22,3 +21,4 @@ export default isVehicle;
  *
  */
 declare function isVehicle(value: any): boolean;
+export default isVehicle;

package/types/isWX.d.ts

@@ -1,4 +1,3 @@
-export default isWX;
 /**
  * 检测值是否为微信号
  *
@@ -14,3 +13,4 @@ export default isWX;
  *
  */
 declare function isWX(value: any): boolean;
+export default isWX;

package/types/listToTree.d.ts

@@ -1,20 +1,25 @@
-export default listToTree;
+type NodeAssign = 'spread' | 'self';
+type Options = {
+    keyField?: string;
+    parentField?: string;
+    childrenField?: string;
+    emptyChildrenValue?: 'none' | 'null' | 'array';
+    nodeAssign?: NodeAssign;
+};
 /**
  * 列表数据转树结构
  *
  * @static
  * @alias module:Tree.listToTree
  * @since 4.14.0
- * @template {Record<string,any>} [T=Record<string,any>]
- * @template {*} [R=T&Record<string,any>]
- * @param {T[]} list 列表数据
+ * @param {object[]} list 列表数据
  * @param {object} [options] 配置项
  * @param {string} [options.keyField='id'] 当前数据的键值字段名称
  * @param {string} [options.parentField='pid'] 当前数据的父级字段名称
  * @param {string} [options.childrenField='children'] 子级字段名称
  * @param {'none'|'null'|'array'} [options.emptyChildrenValue='none'] 子级为空时的值，none表示删除该子级，null表示为null，array表示为[]。
  * @param {'spread'|'self'} [options.nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
- * @returns {R[]} 树结构
+ * @returns {object[]} 树结构
  * @example
  *
  * const menus = [
@@ -34,10 +39,5 @@ export default listToTree;
  * // [{"id":"1","name":"首页","code":"trade","pid":null},{"id":"2","name":"交易管理","code":"trade","pid":null,"childs":[{"id":"3","name":"交易查询","code":"trade-1","pid":"2","childs":[{"id":"4","name":"交易查询-查询操作","code":"trade-1-1","pid":"3"}]}]},{"id":"5","name":"权限管理","code":"authorization","pid":null,"childs":[{"id":"6","name":"角色管理","code":"authorization-1","pid":"5"},{"id":"7","name":"用户管理","code":"authorization-2","pid":"5"}]}]
  *
  */
-declare function listToTree<T extends Record<string, any> = Record<string, any>, R extends unknown = T & Record<string, any>>(list: T[], options?: {
-    keyField?: string | undefined;
-    parentField?: string | undefined;
-    childrenField?: string | undefined;
-    emptyChildrenValue?: "none" | "null" | "array" | undefined;
-    nodeAssign?: "spread" | "self" | undefined;
-} | undefined): R[];
+declare function listToTree<T extends Record<string, any> = Record<string, any>, R extends unknown = T & Record<string, any>>(list: T[], options?: Options): R[];
+export default listToTree;

package/types/minus.d.ts

@@ -1,4 +1,3 @@
-export default minus;
 /**
  * 精确减法，支持多个数相减，减数默认为 0 。
  *
@@ -9,9 +8,11 @@ export default minus;
  * @returns {number} 差
  * @example
  *
+ * minus(1); // 1
  * minus(1, 0.9); // 0.1
  * minus(1, 0.9, 0.02); // 0.08
  * minus(1, 0.9, 0.02, 0.08); // 0
  *
  */
-declare function minus(...nums: (number | string)[]): number;
+declare function minus(...nums: (string | number)[]): number;
+export default minus;

package/types/normalizeString.d.ts

@@ -1,11 +1,10 @@
-export default normalizeString;
 /**
  * 规整化字符串。如果值为 undefined 或 null 将转为空字符串，如果值不是字符串类型将转为字符串。
  *
  * @static
  * @alias module:Processor.normalizeString
  * @since 4.3.0
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances|String}
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances | String}
  * @param {*} value 待处理的值
  * @returns {string} 规整化的值
  * @example
@@ -22,3 +21,4 @@ export default normalizeString;
  *
  */
 declare function normalizeString(value: any): string;
+export default normalizeString;

package/types/numberToChinese.d.ts

@@ -1,4 +1,14 @@
-export default numberToChinese;
+type Options = {
+    big5?: boolean;
+    unit?: boolean;
+    decimal?: string;
+    zero?: string;
+    negative?: string;
+    unitConfig?: {
+        w?: string;
+        y?: string;
+    };
+};
 /**
  * 数字转中文数字<br/><br/>
  *
@@ -37,14 +47,5 @@ export default numberToChinese;
  * numberToChinese(1990, {unit: false, zero:'〇'}); // 一九九〇
  *
  */
-declare function numberToChinese(num: number, options?: {
-    big5?: boolean | undefined;
-    unit?: boolean | undefined;
-    decimal?: string | undefined;
-    zero?: string | undefined;
-    negative?: string | undefined;
-    unitConfig?: {
-        w?: string | undefined;
-        y?: string | undefined;
-    } | undefined;
-} | undefined): string;
+declare function numberToChinese(num: number, options?: Options): string;
+export default numberToChinese;

package/types/padZero.d.ts

@@ -1,4 +1,3 @@
-export default padZero;
 /**
  * 前置补零
  *
@@ -22,4 +21,5 @@ export default padZero;
  * padZero('688', 5); // 00688
  *
  */
-declare function padZero(value: string | number, size?: number | undefined): string;
+declare function padZero(value: string | number, size?: number): string;
+export default padZero;

package/types/parseIdCard.d.ts

@@ -1,58 +1,3 @@
-export default parseIdCard;
-/**
- * - 解析身份证原数据
- */
-export type IdCardOrigin = {
-    /**
-     * - 省份编码
-     */
-    province: string;
-    /**
-     * - 城市编码
-     */
-    city: string;
-    /**
-     * - 地区编码
-     */
-    area: string;
-    /**
-     * - 出生年
-     */
-    year: string;
-    /**
-     * - 出生月
-     */
-    month: string;
-    /**
-     * - 出生日
-     */
-    day: string;
-    /**
-     * - 性别 能整除2为女，否则为男
-     */
-    gender: string;
-};
-/**
- * - 身份证信息
- */
-export type IdCardInfo = {
-    /**
-     * - 省份
-     */
-    province: string;
-    /**
-     * - 生日
-     */
-    birthday: string;
-    /**
-     * - 性别
-     */
-    gender: string;
-    /**
-     * - 解析身份证原数据
-     */
-    origin: IdCardOrigin;
-};
 /**
  * @typedef {Object} IdCardOrigin - 解析身份证原数据
  * @property {string} province - 省份编码
@@ -70,13 +15,28 @@ export type IdCardInfo = {
  * @property {string} gender - 性别
  * @property {IdCardOrigin} origin - 解析身份证原数据
  */
+type IdCardOrigin = {
+    province: string;
+    city: string;
+    area: string;
+    year: string;
+    month: string;
+    day: string;
+    gender: string;
+};
+type IdCardInfo = {
+    province: string;
+    birthday: string;
+    gender: string;
+    origin: IdCardOrigin;
+};
 /**
  * 解析身份证号码，支持15、18位身份证号码
  *
  * @static
  * @alias module:Processor.parseIdCard
  * @since 4.0.0
- * @see {@link https://baike.baidu.com/item/居民身份证号码|居民身份证号码}
+ * @see {@link https://baike.baidu.com/item/居民身份证号码 | 居民身份证号码}
  * @param {string} id 身份证号码，支持15位
  * @returns {IdCardInfo | null} 省份、生日、性别，省/市/区/年/月/日/性别编码。如果解析失败将返回 null 。
  * @example
@@ -105,3 +65,4 @@ export type IdCardInfo = {
  *
  */
 declare function parseIdCard(id: string): IdCardInfo | null;
+export default parseIdCard;

package/types/plus.d.ts

@@ -1,4 +1,3 @@
-export default plus;
 /**
  * 精确加法，支持多个数相加，加数默认为 0 。
  *
@@ -9,9 +8,11 @@ export default plus;
  * @returns {number} 总和
  * @example
  *
+ * plus(0.1); // 0.1
  * plus(0.1, 0.2); // 0.3
  * plus(0.1, 0.2, 0.3); // 0.6
  * plus(0.1, 0.2, 0.3, 0.4); // 1
  *
  */
-declare function plus(...nums: (number | string)[]): number;
+declare function plus(...nums: (string | number)[]): number;
+export default plus;

package/types/randomString.d.ts

@@ -1,4 +1,3 @@
-export default randomString;
 /**
  * 生成随机字符串
  *
@@ -18,4 +17,5 @@ export default randomString;
  * randomString(8, 'abcefg'); // bcgcfabg
  *
  */
-declare function randomString(len?: number | undefined, optionalChars?: string | undefined): string;
+declare function randomString(len?: number, optionalChars?: string): string;
+export default randomString;

package/types/replaceChar.d.ts

@@ -1,4 +1,10 @@
-export default replaceChar;
+type Options = {
+    start?: number;
+    end?: number;
+    char?: string;
+    repeat?: number;
+    exclude?: string;
+};
 /**
  * 替换字符，应用场景如：脱敏
  *
@@ -21,17 +27,20 @@ export default replaceChar;
  * // 身份证 前6后4
  * replaceChar('130701199310302288', { start: 6, end: -4 }); // 130701********2288
  *
- * // 邮箱 @前两位
- * const email = '12345@qq.com'
+ * // 邮箱@前两位
+ * const email = '12345@qq.com';
  * const emailAtIndex = email.indexOf('@');
- * replaceChar(email, { start: emailAtIndex - 2, end: emailAtIndex }); // 123**@qq.com
+ * replaceChar('email', { start: emailAtIndex - 2, end: emailAtIndex }); // 123**@qq.com
+ *
  * // 邮箱 前2和@后面内容，固定替换字符4位
  * replaceChar(email, {start: 2, end: email.indexOf('@'), repeat: 4}); // 12****@qq.com
  *
  * // 银行卡号 只展示后4位，固定替换字符4位
  * replaceChar('6228480402564890018', {start: 0, end: -4, repeat: 4}); // ****0018
+ *
  * // 银行卡号 前6后4
  * replaceChar('6228480402564890018', { start: 6, end: -4 }); // 622848*********0018
+ *
  * // 银行卡号 前4后3 忽略格式的空格
  * replaceChar('6228 4804 0256 4890 018', {start: 4, end: -4, exclude: ' '}); // 6228 **** **** **** 018
  *
@@ -41,10 +50,5 @@ export default replaceChar;
  * replaceChar('林某某某', {start: 1, end: Infinity, repeat: 2}); // 林**
  *
  */
-declare function replaceChar(str: string, options?: {
-    start?: number | undefined;
-    end?: number | undefined;
-    char?: string | undefined;
-    repeat?: number | undefined;
-    exclude?: string | undefined;
-} | undefined): string;
+declare function replaceChar(str: string, options?: Options): string;
+export default replaceChar;

package/types/round.d.ts

@@ -1,4 +1,3 @@
-export default round;
 /**
  * 四舍五入，支持设置精度
  *
@@ -15,4 +14,5 @@ export default round;
  * round(4060, -2); // 4100
  *
  */
-declare function round(num: number | string, precision?: number | undefined): number;
+declare function round(num: string | number, precision?: number): number;
+export default round;