util-helpers 5.1.1 → 5.1.3

package/esm/VERSION.js

@@ -1,4 +1,4 @@
-var VERSION = "5.1.1";
+var VERSION = "5.1.3";
 var VERSION$1 = VERSION;
 
 export { VERSION$1 as default };

package/esm/formatMoney.js

@@ -1,5 +1,5 @@
 import { __read } from 'tslib';
-import { isNaN } from 'ut2';
+import { isString, isNumber, isNaN } from 'ut2';
 import { transformEffectiveNumber, checkBoundary, trimLeftZero } from './utils/math.util.js';
 import devWarn from './utils/devWarn.js';
 import isValidNumber from './isValidNumber.js';
@@ -41,10 +41,9 @@ function formatDec(decStr, precision, decimal) {
     return decimal + ret;
 }
 var formatMoney = function (num, options) {
-    if (num === void 0) { num = ''; }
     if (options === void 0) { options = {}; }
-    var _a = options.precision, precision = _a === void 0 ? 2 : _a, symbol = options.symbol, _b = options.thousand, thousand = _b === void 0 ? ',' : _b, _c = options.decimal, decimal = _c === void 0 ? '.' : _c;
-    if (!checkNumber(num)) {
+    var _a = options.precision, precision = _a === void 0 ? 2 : _a, symbol = options.symbol, _b = options.thousand, thousand = _b === void 0 ? ',' : _b, _c = options.decimal, decimal = _c === void 0 ? '.' : _c, _d = options.strict, strict = _d === void 0 ? true : _d;
+    if (!checkNumber(num) || (strict && (!isString(num) || num === '') && !isNumber(num))) {
         return '';
     }
     if (typeof num === 'number' && !isFinite(num)) {
@@ -60,7 +59,7 @@ var formatMoney = function (num, options) {
     thousand = typeof thousand === 'string' ? thousand : ',';
     decimal = typeof decimal === 'string' ? decimal : '.';
     var strNum = transformEffectiveNumber(num) + '';
-    var _d = __read(strNum.split('.'), 2), intStr = _d[0], decStr = _d[1];
+    var _e = __read(strNum.split('.'), 2), intStr = _e[0], decStr = _e[1];
     return symbol + formatInt(intStr, thousand) + formatDec(decStr, precision, decimal);
 };
 var formatMoney$1 = formatMoney;

package/lib/VERSION.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var VERSION = "5.1.1";
+var VERSION = "5.1.3";
 var VERSION$1 = VERSION;
 
 module.exports = VERSION$1;

package/lib/formatMoney.js

@@ -43,10 +43,9 @@ function formatDec(decStr, precision, decimal) {
     return decimal + ret;
 }
 var formatMoney = function (num, options) {
-    if (num === void 0) { num = ''; }
     if (options === void 0) { options = {}; }
-    var _a = options.precision, precision = _a === void 0 ? 2 : _a, symbol = options.symbol, _b = options.thousand, thousand = _b === void 0 ? ',' : _b, _c = options.decimal, decimal = _c === void 0 ? '.' : _c;
-    if (!checkNumber(num)) {
+    var _a = options.precision, precision = _a === void 0 ? 2 : _a, symbol = options.symbol, _b = options.thousand, thousand = _b === void 0 ? ',' : _b, _c = options.decimal, decimal = _c === void 0 ? '.' : _c, _d = options.strict, strict = _d === void 0 ? true : _d;
+    if (!checkNumber(num) || (strict && (!ut2.isString(num) || num === '') && !ut2.isNumber(num))) {
         return '';
     }
     if (typeof num === 'number' && !isFinite(num)) {
@@ -62,7 +61,7 @@ var formatMoney = function (num, options) {
     thousand = typeof thousand === 'string' ? thousand : ',';
     decimal = typeof decimal === 'string' ? decimal : '.';
     var strNum = math_util.transformEffectiveNumber(num) + '';
-    var _d = tslib.__read(strNum.split('.'), 2), intStr = _d[0], decStr = _d[1];
+    var _e = tslib.__read(strNum.split('.'), 2), intStr = _e[0], decStr = _e[1];
     return symbol + formatInt(intStr, thousand) + formatDec(decStr, precision, decimal);
 };
 var formatMoney$1 = formatMoney;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "5.1.1",
+  "version": "5.1.3",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",

package/types/AsyncMemo.d.ts

@@ -36,7 +36,7 @@ declare class AsyncMemo<DataType = any> {
      * @param {string} [key] 缓存键，如果没有该值将直接执行异步方法。
      * @param {Object} [options] 配置项
      * @param {number} [options.ttl] 数据存活时间
-     * @param {boolean} [options.persisted=true] 数据持久化，如果存在缓存数据，直接返回缓存数据，不再执行异步方法。<br/>即使不开启该配置，不影响在异步执行成功后缓存数据。
+     * @param {boolean} [options.persisted=true] 数据持久化，默认`true`。如果存在缓存数据，直接返回缓存数据，不再执行异步方法。<br/>即使不开启该配置，不影响在异步执行成功后缓存数据。
      * @returns {Promise<*>} 异步结果
      */
     run(asyncFn: (...args: any[]) => Promise<DataType>, key?: string, options?: {

package/types/bytesToSize.d.ts

@@ -10,8 +10,8 @@ type BytesToSizeOptions = {
  * @since 3.8.0
  * @param {number} bytes 字节大小
  * @param {Object} [options] 配置项
- * @param {string} [options.spaceMark=' '] 间隔字符
- * @param {number} [options.precision=2] 精度
+ * @param {string} [options.spaceMark=' '] 间隔字符，默认`' '`
+ * @param {number} [options.precision=2] 精度，默认`2`
  * @returns {string} 存储单位值
  * @example
  *

package/types/calculateCursorPosition.d.ts

@@ -16,8 +16,8 @@ type CalculateCursorPositionOptions = {
  * @param {string} rawValue 当前输入原值
  * @param {string} ctrlValue 当前格式化后的值
  * @param {Object} [options] 配置项
- * @param {string|string[]} [options.placeholderChar=' '] 占位符
- * @param {RegExp} [options.maskReg=/\D/g] 需要遮盖的字符规则。默认去掉非数字，意味着 ctrlValue 需要去掉非数字。
+ * @param {string|string[]} [options.placeholderChar=' '] 占位符，默认`' '`
+ * @param {RegExp} [options.maskReg=/\D/g] 需要遮盖的字符规则。默认`/\D/g` 去掉非数字，意味着 ctrlValue 需要去掉非数字。
  * @param {'mobile'|'bankCard'} [options.type] 格式化类型，内置手机号码和银行卡号特殊处理
  * @returns {number} 格式化后的光标位置
  */

package/types/checkFileType.d.ts

@@ -10,6 +10,26 @@ import { UploadFile } from './utils/file.util';
  * @param {File} file 文件对象。支持 antd `UploadFile` 对象。
  * @param {string} [accept] 文件类型说明符。
  * @returns {boolean} 如果 `file` 符合 `accept` 返回 `true`， 否则返回 `false`。
+ * @example
+ *
+ * const pdf = new File([], '1.pdf', { type: 'application/pdf' });
+ * const jpeg = new File([], 'xx.jpeg', { type: 'image/jpeg' });
+ *
+ * // 文件类型
+ * checkFileType(pdf, 'application/pdf'); // true
+ * checkFileType(jpeg, 'image/jpeg'); // true
+ *
+ * // 通配符
+ * checkFileType(jpeg, 'image/*'); // true
+ * checkFileType(pdf, 'image/*'); // false
+ * checkFileType(pdf, 'application/*'); // true
+ * checkFileType(pdf, '*'); // true
+ * checkFileType(jpeg, '*'); // true
+ *
+ * // 文件名扩展名
+ * checkFileType(jpeg, '.png,.jpeg,.jpg'); // true
+ * checkFileType(pdf, '.pdf'); // true
+ *
  */
 declare function checkFileType(file: File | UploadFile, accept?: string): boolean;
 export default checkFileType;

package/types/compressImage.d.ts

@@ -43,13 +43,13 @@ interface CompressImage {
  * @param {number} [options.width] 自定义图片宽度，默认图片自身宽度
  * @param {number} [options.height] 自定义图片高度，默认图片自身高度
  * @param {number} [options.rotate] 旋转
- * @param {Array | function} [options.offset=[0, 0]] x,y轴偏移值
- * @param {string} [options.background=#fff] 背景颜色
+ * @param {Array | function} [options.offset=[0, 0]] x,y轴偏移值，默认`[0, 0]`
+ * @param {string} [options.background=#fff] 背景颜色，默认`#fff`
  * @param {number | function} [options.canvasWidth] 画布宽度，默认图片宽度
  * @param {number | function} [options.canvasHeight] 画布高度，默认图片高度
- * @param {'blob' | 'dataURL'} [options.format='blob'] 导出格式
- * @param {string} [options.type='image/jpeg'] 图片类型
- * @param {number} [options.quality=0.8] 图片质量
+ * @param {'blob' | 'dataURL'} [options.format='blob'] 导出格式，默认`blob`
+ * @param {string} [options.type='image/jpeg'] 图片类型，默认`image/jpeg`
+ * @param {number} [options.quality=0.8] 图片质量，默认`0.8`
  * @param {function} [options.beforeCompress] 图片加载完成，画布创建之前调用
  * @param {function} [options.beforeDraw] 图片载入画布之前调用
  * @param {function} [options.afterDraw] 图片载入画布之后调用
@@ -60,6 +60,7 @@ interface CompressImage {
  * // 默认返回压缩后的 blob 对象
  * compressImage(file).then(blob=>{
  *    // do something
+ *    // 转为文件对象 new File([blob], file.name, { type: file.type })
  * });
  *
  * // 设置返回格式 data url

package/types/download.d.ts

@@ -35,6 +35,8 @@ type DownloadOptions = {
  *
  * <em style="font-weight: bold;">注意：微信浏览器不支持H5下载文件。</em>
  *
+ * <em>响应头中有 "Content-Disposition" 字段，客户端获取不到？</em> 请参考查阅 [Access-Control-Expose-Headers](https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) 。
+ *
  * @static
  * @alias module:Other.download
  * @since 4.16.0

package/types/fileReader.d.ts

@@ -19,7 +19,7 @@ interface FileReader {
  * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader FileReader}
  * @since 4.16.0
  * @param {Blob} blob Blob 或 File 对象
- * @param {'arrayBuffer'|'binaryString'|'dataURL'|'text'} [type='dataURL'] 读取类型
+ * @param {'arrayBuffer'|'binaryString'|'dataURL'|'text'} [type='dataURL'] 读取类型，默认`dataURL`。可选 `arrayBuffer`  `binaryString` `dataURL` `text` 。
  * @returns {Promise<string|ArrayBuffer>} 文件内容
  * @example
  * const aFileParts = ['<a id="a"><b id="b">hey!</b></a>']; // 一个包含DOMString的数组

package/types/filterTree.d.ts

@@ -9,8 +9,8 @@ type NodeAssign = 'spread' | 'self';
  * @since 4.15.0
  * @param {Object[]} tree 树结构数据
  * @param {function} predicate 遍历每一项执行的函数，参数是当前遍历到的节点数据，如果返回 `Truthy` ，结果将包含该节点
- * @param {string} [childrenField='children'] 子级字段名
- * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
+ * @param {string} [childrenField='children'] 子级字段名，默认`children`
+ * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式，默认`spread`。`spread`表示使用展开运算符创建新值，`self`-表示使用自身对象。
  * @returns {Object[]}
  * @example
  * const menus = [{ id: '1', name: '首页', code: 'trade', pid: null }, { id: '2', name: '交易管理', code: 'trade', pid: null, children: [{ id: '3', name: '交易查询', code: 'trade-1', pid: '2', children: [{ id: '4', name: '交易查询-查询操作', code: 'trade-1-1', pid: '3' }]}]}, { id: '5', name: '权限管理', code: 'authorization', pid: null, children: [{ id: '6', name: '角色管理', code: 'authorization-1', pid: '5' }, { id: '7', name: '用户管理', code: 'authorization-2', pid: '5' }]}];

package/types/findTreeNode.d.ts

@@ -6,7 +6,7 @@
  * @since 4.14.0
  * @param {Object[]} tree 树结构数据
  * @param {function} predicate 遍历每一项执行的函数，参数是当前遍历到的节点数据，如果返回 `Truthy` ，将返回该节点
- * @param {string} [childrenField='children'] 子级字段名
+ * @param {string} [childrenField='children'] 子级字段名，默认`children`
  * @returns {Object|undefined}
  * @example
  * const menus = [{ id: '1', name: '首页', code: 'trade', pid: null }, { id: '2', name: '交易管理', code: 'trade', pid: null, children: [{ id: '3', name: '交易查询', code: 'trade-1', pid: '2', children: [{ id: '4', name: '交易查询-查询操作', code: 'trade-1-1', pid: '3' }]}]}, { id: '5', name: '权限管理', code: 'authorization', pid: null, children: [{ id: '6', name: '角色管理', code: 'authorization-1', pid: '5' }, { id: '7', name: '用户管理', code: 'authorization-2', pid: '5' }]}];

package/types/findTreeNodes.d.ts

@@ -6,7 +6,7 @@
  * @since 4.15.0
  * @param {Object[]} tree 树结构数据
  * @param {function} predicate 遍历每一项执行的函数，参数是当前遍历到的节点数据，如果返回 Truthy ，返回结果将包含该节点
- * @param {string} [childrenField='children'] 子级字段名
+ * @param {string} [childrenField='children'] 子级字段名，默认`children`
  * @returns {Object[]}
  * @example
  * const menus = [{ id: '1', name: '首页', code: 'trade', pid: null }, { id: '2', name: '交易管理', code: 'trade', pid: null, children: [{ id: '3', name: '交易查询', code: 'trade-1', pid: '2', children: [{ id: '4', name: '交易查询-查询操作', code: 'trade-1-1', pid: '3' }]}]}, { id: '5', name: '权限管理', code: 'authorization', pid: null, children: [{ id: '6', name: '角色管理', code: 'authorization-1', pid: '5' }, { id: '7', name: '用户管理', code: 'authorization-2', pid: '5' }]}];

package/types/findTreeSelect.d.ts

@@ -6,7 +6,7 @@
  * @since 4.14.0
  * @param {Object[]} tree 树结构数据
  * @param {function} predicate 遍历每一项执行的函数，参数是当前遍历到的节点数据，如果返回 Truthy 将返回包含该节点的所有父级节点
- * @param {string} [childrenField='children'] 子级字段名
+ * @param {string} [childrenField='children'] 子级字段名，默认`children`
  * @returns {Object[]}
  * @example
  * const menus = [{ id: '1', name: '首页', code: 'trade', pid: null }, { id: '2', name: '交易管理', code: 'trade', pid: null, children: [{ id: '3', name: '交易查询', code: 'trade-1', pid: '2', children: [{ id: '4', name: '交易查询-查询操作', code: 'trade-1-1', pid: '3' }]}]}, { id: '5', name: '权限管理', code: 'authorization', pid: null, children: [{ id: '6', name: '角色管理', code: 'authorization-1', pid: '5' }, { id: '7', name: '用户管理', code: 'authorization-2', pid: '5' }]}];

package/types/formatBankCard.d.ts

@@ -10,8 +10,8 @@ type Options = {
  * @since 1.1.0
  * @param {string} bankCardNo 要处理的字符串
  * @param {Object} [options] 配置项
- * @param {string} [options.spaceMark=' '] 间隔字符
- * @param {number} [options.length=4] 间隔长度
+ * @param {string} [options.spaceMark=' '] 间隔字符，默认`' '`
+ * @param {number} [options.length=4] 间隔长度，默认`4`
  * @returns {string} 格式化的银行卡号
  * @example
  *

package/types/formatMobile.d.ts

@@ -9,7 +9,7 @@ type Options = {
  * @since 4.5.0
  * @param {string} mobileNo 手机号码
  * @param {Object} [options] 配置项
- * @param {string} [options.spaceMark=' '] 间隔字符
+ * @param {string} [options.spaceMark=' '] 间隔字符，默认`' '`
  * @returns {string} 格式化后的手机号码
  * @example
  *

package/types/formatMoney.d.ts

@@ -3,6 +3,7 @@ type Options = {
     symbol?: string;
     thousand?: string;
     decimal?: string;
+    strict?: boolean;
 };
 /**
  * 格式化金额
@@ -12,10 +13,11 @@ type Options = {
  * @since 1.1.0
  * @param {string | number} num 需转换金额 (最大：9007199254740991 最小： -9007199254740991)
  * @param {Object} [options] 金额格式化配置
- * @param {number} [options.precision=2] 保留位数 （最高：10位）
+ * @param {number} [options.precision=2] 保留位数，默认`2`。最高`10`。
  * @param {string} [options.symbol] 货币符号
- * @param {string} [options.thousand=","] 千分位符号
- * @param {string} [options.decimal="."] 小数位符号
+ * @param {string} [options.thousand=","] 千分位符号， 默认`,`
+ * @param {string} [options.decimal="."] 小数位符号，默认`.`
+ * @param {boolean} [options.strict=ture] 严格模式，默认`true`。开启后，只支持非空字符串和数字格式化，其他类型值如`null` `undefined` `true` `false`等将返回空字符串。
  * @returns {string} 格式化的金额
  * @example
  *

package/types/getFileType.d.ts

@@ -5,8 +5,17 @@ import { UploadFile } from './utils/file.util';
  * @static
  * @alias module:Other.getFileType
  * @since 5.1.0
+ * @requires Other.checkFileType
  * @param {File} file 文件对象。支持 antd `UploadFile` 对象。
  * @returns {"image" | "audio" | "video" | "pdf" | "word" | "excel" | undefined} 如果是 `image` `audio` `video` `pdf` `word` `excel` 这些类型的文件，返回对应的类型值，否则返回 `undefined`。
+ * @example
+ *
+ * const pdf = new File([], '1.pdf', { type: 'application/pdf' });
+ * const jpeg = new File([], 'xx.jpeg', { type: 'image/jpeg' });
+ *
+ * getFileType(pdf); // 'pdf'
+ * getFileType(jpeg); // 'image'
+ *
  */
 declare function getFileType(file: File | UploadFile): "image" | "audio" | "video" | "pdf" | "word" | "excel" | undefined;
 export default getFileType;

package/types/isBankCard.d.ts

@@ -11,8 +11,8 @@ type Options = {
  * @see {@link https://kf.qq.com/faq/170112ABnm6b170112FvquAn.html 常用银行账号位数参考}
  * @param {*} value 要检测的值
  * @param {Object} [options] 配置项
- * @param {boolean} [options.loose=false] 宽松模式，8-30位数字
- * @param {boolean} [options.luhn=false] 使用 Luhn 算法校验校验码
+ * @param {boolean} [options.loose=false] 宽松模式，默认`false`。正常模式10-21位数字（个人账户），宽松模式8-30位数字（企业账户）。
+ * @param {boolean} [options.luhn=false] 使用 Luhn 算法校验校验码，默认`false`
  * @returns {boolean} 值是否为银行卡号
  * @example
  *

package/types/isBusinessLicense.d.ts

@@ -10,7 +10,7 @@ type Options = {
  * @see {@link https://wenku.baidu.com/view/19873704cc1755270722087c.html GS15—2006 工商行政管理市场主体注册号编制规则}
  * @param {*} value 要检测的值
  * @param {Object} [options] 配置项
- * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，如果为false，不校验校验位。
+ * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，默认`true`。如果为false，不校验校验位。
  * @returns {boolean} 值是否为营业执照号
  * @example
  *

package/types/isChinese.d.ts

@@ -13,8 +13,8 @@ type Options = {
  * @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/isIdCard.d.ts

@@ -14,8 +14,8 @@ type Options = {
  * @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/isPassword.d.ts

@@ -11,9 +11,9 @@ import validatePassword from './validatePassword';
  * @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/isTWCard.d.ts

@@ -10,7 +10,7 @@ type Options = {
  * @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/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/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

@@ -20,14 +20,14 @@ type Options = {
  * @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/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/setDataURLPrefix.d.ts

@@ -9,8 +9,8 @@
  * @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}
  * @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

@@ -26,9 +26,9 @@ type Options = {
  * @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
  *