util-helpers 5.1.2 → 5.2.0

package/types/isChinese.d.ts

@@ -8,13 +8,13 @@ type Options = {
  * @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
- * @param {boolean} [options.useExtend=false] 使用统一表意文字扩展A-I。注意：如果不支持 `RegExp.prototype.unicode`，扩展字符集将自动不生效，如IE浏览器。
+ * @param {boolean} [options.loose=false] 宽松模式，默认`false`。如果为`true`，只要包含中文就返回`true`
+ * @param {boolean} [options.useExtend=false] 使用统一表意文字扩展A-I，默认`false`。注意：如果不支持 `RegExp.prototype.unicode`，扩展字符集将自动不生效，如IE浏览器。
  * @returns {boolean} 值是否为中文
  * @example
  *

package/types/isHMCard.d.ts

@@ -4,7 +4,7 @@
  * @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

package/types/isIdCard.d.ts

@@ -10,12 +10,12 @@ type Options = {
  * @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位身份证号码
- * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，仅支持18位身份证号码
+ * @param {boolean} [options.loose=false] 宽松模式，默认`false`。如果为`true`，支持15位身份证号码
+ * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，默认`true`。仅在`loose=false`时生效
  * @returns {boolean} 值是否为身份证号
  * @example
  *

package/types/isPassport.d.ts

@@ -5,7 +5,7 @@
  * @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

package/types/isPassword.d.ts

@@ -8,12 +8,12 @@ import validatePassword from './validatePassword';
  * @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-包含三种字符。（大写字母、小写字母、数字、特殊字符）
- * @param {boolean} [options.ignoreCase=false] 是否忽略大小写，为 ture 时，大小写字母视为一种字符
- * @param {string} [options.special="!@#$%^&*()-=_+[]\|{},./?<>~"] 支持的特殊字符
+ * @param {number} [options.level=2] 密码强度，默认`2`。`1`-包含一种字符 `2`-包含两种字符 `3`-包含三种字符。（大写字母、小写字母、数字、特殊字符）
+ * @param {boolean} [options.ignoreCase=false] 是否忽略大小写，默认`false`。为 ture 时，大小写字母视为一种字符
+ * @param {string} [options.special="!@#$%^&*()-=_+[]\|{},./?<>~"] 支持的特殊字符，默认`!@#$%^&*()-=_+[]\|{},./?<>~`
  * @returns {boolean} 值是否符合密码强度
  * @example
  *

package/types/isSocialCreditCode.d.ts

@@ -7,7 +7,7 @@ type Options = {
  * @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，不校验校验位。

package/types/isSwiftCode.d.ts

@@ -4,7 +4,7 @@
  * @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

package/types/isTWCard.d.ts

@@ -7,10 +7,10 @@ type Options = {
  * @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，表示支持一次性短期通行证
+ * @param {boolean} [options.loose=false] 宽松模式，默认`false`。如果为true，表示支持一次性短期通行证
  * @returns {boolean} 是否为台湾居民来往大陆通行证
  * @example
  *

package/types/isUrl.d.ts

@@ -4,7 +4,7 @@
  * @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

package/types/isValidNumber.d.ts

@@ -5,7 +5,7 @@
  * @alias module:Validator.isValidNumber
  * @since 4.17.2
  * @param {*} value 待检测的值
- * @param {boolean} [strict=false] 严格模式，如果为 true ，仅支持字符串和数字类型，不处理其他类型隐式转换，且空字符串返回 false 。
+ * @param {boolean} [strict=false] 严格模式，默认`false`。如果为 true ，仅支持字符串和数字类型，不处理其他类型隐式转换，且空字符串返回 false 。
  * @returns {boolean} 值是否为有效数值
  * @example
  *

package/types/isVehicle.d.ts

@@ -4,7 +4,7 @@
  * @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

package/types/lcm.d.ts

@@ -14,7 +14,7 @@
  * @static
  * @alias module:Math.lcm
  * @since 4.20.0
- * @see {@link https://baike.baidu.com/item/最小公倍数 最小公倍数}
+ * @see {@link https://baike.baidu.com/item/最小公倍数 | 最小公倍数}
  * @param {...(number|string)} nums 两个或多个整数。
  * @returns {number} 最小公倍数。
  * @example

package/types/listToTree.d.ts

@@ -14,11 +14,11 @@ type Options = {
  * @since 4.14.0
  * @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表示使用自身对象。
+ * @param {string} [options.keyField='id'] 当前数据的键值字段名称，默认`id`
+ * @param {string} [options.parentField='pid'] 当前数据的父级字段名称，默认`pid`
+ * @param {string} [options.childrenField='children'] 子级字段名称，默认`children`
+ * @param {'none'|'null'|'array'} [options.emptyChildrenValue='none'] 子级为空时的值，默认`none`。`none`表示删除该子级，`null`表示为`null`，`array`表示为`[]`。
+ * @param {'spread'|'self'} [options.nodeAssign='spread'] 节点赋值方式，默认`spread`。`spread`表示使用展开运算符创建新值，`self`表示使用自身对象。
  * @returns {Object[]} 树结构
  * @example
  *

package/types/loadScript.d.ts

@@ -12,10 +12,10 @@ type ScriptAttribute = Pick<HTMLScriptElement, 'async' | 'crossOrigin' | 'defer'
  * @since 4.19.0
  * @param {string} src  js 地址。
  * @param {Object} [options] script 标签属性。比如 `defer` `onload` `onerror` `id` 等，下面列举部分带有默认值或额外扩展的配置。
- * @param {boolean} [options.destroyOnError=true] 如果加载失败或错误，自动删除 dom 中的 script 标签。
+ * @param {boolean} [options.destroyOnError=true] 如果加载失败或错误，自动删除 dom 中的 script 标签。默认`true`
  * @param {Object} [options.attrs] 自定义 script 属性，通过 script.setAttribute 设置。
- * @param {boolean} [options.async=true] 异步加载。
- * @param {string} [options.type='text/javascript'] 类型。
+ * @param {boolean} [options.async=true] 异步加载。默认`true`
+ * @param {string} [options.type='text/javascript'] 类型。默认`text/javascript`
  * @return {Promise<HTMLScriptElement>} 异步返回 script 元素。
  * @example
  *

package/types/numberToChinese.d.ts

@@ -17,17 +17,17 @@ type Options = {
  * @static
  * @alias module:Processor.numberToChinese
  * @since 1.2.0
- * @see {@link https://openstd.samr.gov.cn/bzgk/gb/newGbInfo?hcno=F5DAC3377DA99C8D78AE66735B6359C7 出版物上数字用法}
+ * @see {@link https://openstd.samr.gov.cn/bzgk/gb/newGbInfo?hcno=F5DAC3377DA99C8D78AE66735B6359C7 | 出版物上数字用法}
  * @param {number} num 数字
  * @param {Object} [options] 配置项
- * @param {boolean} [options.big5=false] 繁体
- * @param {boolean} [options.unit=true] 计数单位
- * @param {string} [options.decimal="点"] 中文小数点，繁体字为點
- * @param {string} [options.zero="零"] 设置0。常用配置 〇
- * @param {string} [options.negative="负"] 负数前面的字
+ * @param {boolean} [options.big5=false] 繁体，默认`false`
+ * @param {boolean} [options.unit=true] 计数单位，默认`true`
+ * @param {string} [options.decimal="点"] 中文小数点。默认`点`，当`big5=true`时，默认`點`
+ * @param {string} [options.zero="零"] 设置0，默认`零`。常用配置 〇
+ * @param {string} [options.negative="负"] 负数前面的字，默认`负`
  * @param {Object} [options.unitConfig] 节点单位配置
- * @param {string} [options.unitConfig.w="万"] 设置计数单位万。常用配置 萬
- * @param {string} [options.unitConfig.y="亿"] 设置计数单位亿。常用配置 億
+ * @param {string} [options.unitConfig.w="万"] 设置计数单位万，默认`万`。常用配置 萬
+ * @param {string} [options.unitConfig.y="亿"] 设置计数单位亿，默认`亿`。常用配置 億
  * @returns {string} 中文数字
  * @example
  *

package/types/padZero.d.ts

@@ -5,7 +5,7 @@
  * @alias module:Processor.padZero
  * @since 4.7.0
  * @param {string|number} value 要处理的值
- * @param {number} [size=2] 指定字符串长度
+ * @param {number} [size=2] 指定字符串长度，默认`2`
  * @returns {string} 用零填充数字到给定长度的字符串
  * @example
  * padZero(5); // 05

package/types/parseIdCard.d.ts

@@ -36,7 +36,7 @@ type IdCardInfo = {
  * @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

package/types/randomString.d.ts

@@ -8,8 +8,8 @@ interface RandomString {
  * @function
  * @alias module:Other.randomString
  * @since 4.8.0
- * @param {number} [len=0] 长度
- * @param {'number' | 'lower' | 'upper' | string} [pool='0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'] 字符池，默认为数字和大小写字母，支持number/lower/upper
+ * @param {number} [len=0] 长度，默认`0`
+ * @param {'number' | 'lower' | 'upper' | string} [pool='0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'] 字符池，默认为数字和大小写字母。支持设置类型`number` `lower` `upper` 或字符串。
  * @returns {string} 随机字符串
  * @example
  *

package/types/replaceChar.d.ts

@@ -13,9 +13,9 @@ type Options = {
  * @since 1.1.0
  * @param {string} str 要处理的字符串
  * @param {Object} [options] 配置项
- * @param {number} [options.start=3] 开始位置
- * @param {number} [options.end=-4] 结束位置
- * @param {string} [options.char="*"] 替换字符
+ * @param {number} [options.start=3] 开始位置，默认`3`
+ * @param {number} [options.end=-4] 结束位置，默认`-4`
+ * @param {string} [options.char="*"] 替换字符，默认`*`
  * @param {number} [options.repeat] 替换字符的重复次数，默认为替换内容长度，可设置为固定值
  * @param {string} [options.exclude] 排除字符，如果指定排除项，repeat设置无效
  * @returns {string} 处理后的字符

package/types/round.d.ts

@@ -5,7 +5,7 @@
  * @alias module:Math.round
  * @since 3.1.0
  * @param {number|string} num 要四舍五入的数字
- * @param {number} [precision=0] 四舍五入的精度
+ * @param {number} [precision=0] 四舍五入的精度，默认`0`
  * @returns {number} 四舍五入的数字
  * @example
  *

package/types/safeDate.d.ts

@@ -13,7 +13,7 @@ interface SafeDate {
  * @function
  * @alias module:Processor.safeDate
  * @since 4.4.0
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Date Date}
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Date | Date}
  * @param {string|number|Date} [value] 日期时间字符串、毫秒数、日期对象
  * @param {...number} [args] 月/日/时/分/秒/毫秒
  * @returns {Date} Date 实例日期对象

package/types/setDataURLPrefix.d.ts

@@ -6,11 +6,11 @@
  * @static
  * @alias module:Processor.setDataURLPrefix
  * @since 4.1.0
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URLs}
- * @see {@link https://mimesniff.spec.whatwg.org/#understanding-mime-types MIME types}
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/URI/Schemes/data | Data URLs}
+ * @see {@link https://www.iana.org/assignments/media-types/media-types.xhtml | Media Types}
  * @param {string} data 数据本身
- * @param {string} [mimeType="image/png"] MIME 类型
- * @param {boolean} [base64=true] 添加 base64 标识
+ * @param {string} [mimeType="image/png"] MIME 类型，默认`image/png`
+ * @param {boolean} [base64=true] 添加 base64 标识，默认`true`
  * @returns {string} DataURL 格式的字符串
  * @example
  *

package/types/transformFieldNames.d.ts

@@ -12,7 +12,7 @@ type TransformFieldNames<D extends any, F extends Record<string, any>, C extends
  * @param {Object[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField
  * @param {Object} fieldNames 字段名映射
  * @param {string} [childrenField] 子级数据字段名
- * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
+ * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式，默认`spread`。`spread`表示使用展开运算符创建新值，`self`表示使用自身对象。
  * @returns {Object[]}
  * @example
  *

package/types/transformObjectValue.d.ts

@@ -15,7 +15,7 @@ interface TransformObjectValue {
  * @since 4.23.0
  * @param {Array | Object} data 要转换值的普通对象或数组
  * @param {Function} fn 遍历普通对象或数组键值方法
- * @param {boolean} [deep=true] 深度遍历，检测值为普通对象或数组时递归处理。默认 true 。
+ * @param {boolean} [deep=true] 深度遍历，检测值为普通对象或数组时递归处理。默认`true`
  * @returns {Array | Object} 如果是普通对象或数组，返回一个新的对象或数组，否则返回自身
  * @example
  *

package/types/validatePassword.d.ts

@@ -23,12 +23,12 @@ type Options = {
  * @static
  * @alias module:Validator.validatePassword
  * @since 3.7.0
- * @see {@link https://baike.baidu.com/item/ASCII#3 ASCII}
+ * @see {@link https://baike.baidu.com/item/ASCII#3 | ASCII}
  * @param {string} value 要检测的值
  * @param {Object} [options] 配置项
- * @param {number} [options.level=2] 密码强度 1-包含一种字符 2-包含两种字符 3-包含三种字符。（大写字母、小写字母、数字、特殊字符）
- * @param {boolean} [options.ignoreCase=false] 是否忽略大小写，为 ture 时，大小写字母视为一种字符
- * @param {string} [options.special="!@#$%^&*()-=_+[]\|{},./?<>~"] 支持的特殊字符
+ * @param {number} [options.level=2] 密码强度，默认`2`。`1`-包含一种字符 `2`-包含两种字符 `3`-包含三种字符。（大写字母、小写字母、数字、特殊字符）
+ * @param {boolean} [options.ignoreCase=false] 是否忽略大小写，默认`false`。如果为`ture`，大小写字母视为一种字符
+ * @param {string} [options.special="!@#$%^&*()-=_+[]\|{},./?<>~"] 支持的特殊字符，默认`!@#$%^&*()-=_+[]\|{},./?<>~`
  * @returns {ValidatePasswordReturn} 验证结果
  * @example
  *