util-helpers 4.15.0 → 4.15.2

package/lib/utils/config.js

@@ -24,5 +24,5 @@ function setDisableWarning(bool) {
 }
 
 // eslint-disable-next-line no-undef
-var version = "4.15.0";
+var version = "4.15.2";
 exports.version = version;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.15.0",
+  "version": "4.15.2",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -10,6 +10,7 @@
   "scripts": {
     "test": "jest --verbose",
     "test:coverage": "jest --coverage",
+    "test:coverage:local": "cross-env COVERAGE_LOCAL=1 jest --coverage",
     "test:math": "jest --verbose test/math",
     "test:type": "jest --verbose test/type",
     "test:validator": "jest --verbose test/validator",

package/types/bytesToSize.d.ts

@@ -8,6 +8,7 @@ export default bytesToSize;
  * @param {number} bytes 字节大小
  * @param {Object} [options] 配置项
  * @param {string} [options.spaceMark=' '] 间隔字符
+ * @param {number} [options.precision=2] 精度
  * @returns {string} 存储单位值
  * @example
  *
@@ -23,4 +24,5 @@ export default bytesToSize;
  */
 declare function bytesToSize(bytes: number, options?: {
     spaceMark?: string | undefined;
+    precision?: number | undefined;
 } | undefined): string;

package/types/formatMoney.d.ts

@@ -6,25 +6,25 @@ export default formatMoney;
  * @alias module:Processor.formatMoney
  * @since 1.1.0
  * @param {string | number} num 需转换金额 (最大：9007199254740991 最小： -9007199254740991)
- * @param {Object} [options] - 金额格式化配置
- * @param {string | number} [options.precision=2] - 保留位数 （最高：10位）
- * @param {string} [options.symbol] - 货币符号
- * @param {string} [options.thousand=","] - 千分位符号
- * @param {string} [options.decimal="."] - 小数位符号
+ * @param {Object} [options] 金额格式化配置
+ * @param {number} [options.precision=2] 保留位数 （最高：10位）
+ * @param {string} [options.symbol] 货币符号
+ * @param {string} [options.thousand=","] 千分位符号
+ * @param {string} [options.decimal="."] 小数位符号
  * @returns {string} 格式化的金额
  * @example
  *
  * // 整数
- * formatMoney('1000'); // 1,000.00
+ * formatMoney(1000); // 1,000.00
  *
  * // 小数（默认保留2位小数）
- * formatMoney('3000.03'); // 3,000.03
+ * formatMoney(3000.03); // 3,000.03
  *
  * // 保留4位小数
- * formatMoney('3000.0300', { precision: 4 }); // 3,000.0300
+ * formatMoney(3000.03, { precision: 4 }); // 3,000.0300
  *
  * // 保留10位小数
- * formatMoney('1500.2', { precision: 10 }); // 1,500.2000000000
+ * formatMoney(1500.2, { precision: 10 }); // 1,500.2000000000
  *
  * // 自定义单位符号
  * formatMoney(1000.00, { symbol: '$' }); // $1,000.00
@@ -35,9 +35,11 @@ export default formatMoney;
  * // 自定义小数位分割符(默认'.')
  * formatMoney(1000.00, { decimal: '&' }); // 1,000&00
  *
+ * // 字符串数字
+ * formatMoney('3000.03', { precision: 4 }); // 3,000.0300
  */
 declare function formatMoney(num: string | number, options?: {
-    precision?: string | number | undefined;
+    precision?: number | undefined;
     symbol?: string | undefined;
     thousand?: string | undefined;
     decimal?: string | undefined;

package/types/listToTree.d.ts

@@ -8,7 +8,7 @@ export default listToTree;
  * @template {Record<string,any>} [T=Record<string,any>]
  * @template {*} [R=T&Record<string,any>]
  * @param {T[]} list 列表数据
- * @param {object} options 配置项
+ * @param {object} [options] 配置项
  * @param {string} [options.keyField='id'] 当前数据的键值字段名称
  * @param {string} [options.parentField='pid'] 当前数据的父级字段名称
  * @param {string} [options.childrenField='children'] 子级字段名称
@@ -40,4 +40,4 @@ declare function listToTree<T extends Record<string, any> = Record<string, any>,
     childrenField?: string | undefined;
     emptyChildrenValue?: "none" | "null" | "array" | undefined;
     nodeAssign?: "spread" | "self" | undefined;
-}): R[];
+} | undefined): R[];