@planarcat/js-toolkit 1.4.0 → 1.5.0

package/README.md

@@ -235,8 +235,10 @@ npm run test:coverage
 
 - ✨ 优化数字格式化功能，无数字字符串返回 `0` 而不是 `NaN`
 - ✨ 改进 `toFormattedNumberString` 函数，无数字字符串直接返回 `zeroValue`
+- ✨ 为 `toFormattedNumberString` 函数的前缀后缀添加函数类型支持
 - ✨ 完善文档和测试用例
 - ✨ 优化深层数组处理逻辑
+- ✨ 修复 0 值、NaN 值和无数字字符串的前缀后缀处理问题
 
 ### v1.3.0
 

package/dist/object/toFormattedNumberString.d.ts

@@ -1,4 +1,4 @@
-declare function toFormattedNumberString(object: unknown[], options?: import("../types/object").ToFormattedNumberStringOptions): string[];
-declare function toFormattedNumberString(object: unknown, options?: import("../types/object").ToFormattedNumberStringOptions): string | string[];
+declare function toFormattedNumberString(object: unknown[], options?: import('../types/object').ToFormattedNumberStringOptions): string[];
+declare function toFormattedNumberString(object: unknown, options?: import('../types/object').ToFormattedNumberStringOptions): string | string[];
 export default toFormattedNumberString;
 //# sourceMappingURL=toFormattedNumberString.d.ts.map

package/dist/object/toFormattedNumberString.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toFormattedNumberString.d.ts","sourceRoot":"","sources":["../../src/object/toFormattedNumberString.ts"],"names":[],"mappings":"AA2DA,iBAAS,uBAAuB,CAC9B,MAAM,EAAE,OAAO,EAAE,EACjB,OAAO,CAAC,EAAE,OAAO,iBAAiB,EAAE,8BAA8B,GACjE,MAAM,EAAE,CAAC;AAEZ,iBAAS,uBAAuB,CAC9B,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,OAAO,iBAAiB,EAAE,8BAA8B,GACjE,MAAM,GAAG,MAAM,EAAE,CAAC;AA2GrB,eAAe,uBAAuB,CAAC"}
+{"version":3,"file":"toFormattedNumberString.d.ts","sourceRoot":"","sources":["../../src/object/toFormattedNumberString.ts"],"names":[],"mappings":"AAuEA,iBAAS,uBAAuB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,iBAAiB,EAAE,8BAA8B,GAAG,MAAM,EAAE,CAAC;AAElI,iBAAS,uBAAuB,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,iBAAiB,EAAE,8BAA8B,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAyHzI,eAAe,uBAAuB,CAAC"}

package/dist/object/toFormattedNumberString.js

@@ -19,8 +19,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * @param options.zeroValue - 当值为0时的显示，默认'0'
  * @param options.useLocalizedFormat - 是否使用本地化格式，默认false
  * @param options.preProcessor - 预处理函数，在数字转换后、字符串格式化前应用
- * @param options.prefix - 前缀，默认''
- * @param options.suffix - 后缀，默认''
+ * @param options.prefix - 前缀，可以是字符串或函数，默认''
+ *                          如果是函数，会接收格式化前的数字作为参数，返回字符串作为前缀
+ * @param options.suffix - 后缀，可以是字符串或函数，默认''
+ *                          如果是函数，会接收格式化前的数字作为参数，返回字符串作为后缀
  *
  * @returns 格式化后的数字字符串或字符串数组
  *          - 如果输入是单个值，返回格式化后的字符串
@@ -51,6 +53,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
  *   suffix: '%'
  * }); // "12.34%"
  *
+ * // 函数类型前缀
+ * toFormattedNumberString(123.456, {
+ *   prefix: (num) => `$${Math.floor(num)}`
+ * }); // "$123123.456"
+ *
+ * // 函数类型后缀
+ * toFormattedNumberString(123.456, {
+ *   suffix: (num) => `/${num.toFixed(0)}`
+ * }); // "123.456/123"
+ *
  * // 处理数组
  * toFormattedNumberString([123.456, '789.012'], { decimalPlaces: 2 }); // ["123.46", "789.01"]
  *
@@ -63,7 +75,30 @@ const toFormattedNumber_1 = __importDefault(require("./toFormattedNumber"));
 // 主函数实现
 function toFormattedNumberString(object, options) {
     // 解构并设置默认值
-    const { decimalPlaces = true, nanValue = "NaN", zeroValue = "0", useLocalizedFormat = false, preProcessor, prefix = "", suffix = "", } = options || {};
+    const { decimalPlaces = true, nanValue = 'NaN', zeroValue = '0', useLocalizedFormat = false, preProcessor, prefix = '', suffix = '' } = options || {};
+    /**
+     * 处理前缀或后缀，可以是字符串或函数
+     * @param prefixOrSuffix - 前缀或后缀，可以是字符串或函数
+     * @param num - 要传递给函数的数字
+     * @returns 处理后的前缀或后缀字符串
+     */
+    const processPrefixSuffix = (prefixOrSuffix, num) => {
+        if (typeof prefixOrSuffix === 'function') {
+            return prefixOrSuffix(num);
+        }
+        return prefixOrSuffix;
+    };
+    /**
+     * 添加前缀和后缀
+     * @param str - 要添加前缀后缀的字符串
+     * @param num - 要传递给前缀后缀函数的数字
+     * @returns 添加了前缀后缀的字符串
+     */
+    const addPrefixSuffix = (str, num) => {
+        const processedPrefix = processPrefixSuffix(prefix, num);
+        const processedSuffix = processPrefixSuffix(suffix, num);
+        return `${processedPrefix}${str}${processedSuffix}`;
+    };
     /**
      * 将单个数字转换为格式化字符串
      * @param num - 要转换的数字
@@ -72,7 +107,7 @@ function toFormattedNumberString(object, options) {
     const convertNumberToString = (num) => {
         // 处理0情况
         if (num === 0) {
-            return zeroValue;
+            return addPrefixSuffix(zeroValue, num);
         }
         // 应用预处理函数
         const processedNum = preProcessor ? preProcessor(num) : num;
@@ -104,7 +139,7 @@ function toFormattedNumberString(object, options) {
             }
         }
         // 添加前缀和后缀
-        return `${prefix}${strNum}${suffix}`;
+        return addPrefixSuffix(strNum, processedNum);
     };
     /**
      * 检查字符串是否包含数字
@@ -126,9 +161,9 @@ function toFormattedNumberString(object, options) {
         }
         else {
             // 检查是否为无数字的字符串
-            if (typeof value === "string" && !hasNumbers(value)) {
+            if (typeof value === 'string' && !hasNumbers(value)) {
                 // 无数字的字符串返回0
-                return zeroValue;
+                return addPrefixSuffix(zeroValue, 0);
             }
             // 对于其他类型，首先将输入转换为数字
             // 注意：toFormattedNumber对于单个值会返回number类型
@@ -139,7 +174,7 @@ function toFormattedNumberString(object, options) {
             // 检查是否为NaN
             if (isNaN(num)) {
                 // 其他NaN情况，使用nanValue
-                return nanValue;
+                return addPrefixSuffix(nanValue, num);
             }
             // 正常数字转换
             return convertNumberToString(num);

package/dist/object/toFormattedNumberString.js.map

@@ -1 +1 @@
-{"version":3,"file":"toFormattedNumberString.js","sourceRoot":"","sources":["../../src/object/toFormattedNumberString.ts"],"names":[],"mappings":";;;;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,4EAAoD;AAYpD,QAAQ;AACR,SAAS,uBAAuB,CAC9B,MAAe,EACf,OAAkE;IAElE,WAAW;IACX,MAAM,EACJ,aAAa,GAAG,IAAI,EACpB,QAAQ,GAAG,KAAK,EAChB,SAAS,GAAG,GAAG,EACf,kBAAkB,GAAG,KAAK,EAC1B,YAAY,EACZ,MAAM,GAAG,EAAE,EACX,MAAM,GAAG,EAAE,GACZ,GAAG,OAAO,IAAI,EAAE,CAAC;IAElB;;;;OAIG;IACH,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAU,EAAE;QACpD,QAAQ;QACR,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;YACd,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,UAAU;QACV,MAAM,YAAY,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAE5D,YAAY;QACZ,IAAI,MAAc,CAAC;QACnB,IAAI,kBAAkB,EAAE,CAAC;YACvB,UAAU;YACV,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;gBAC3B,UAAU;gBACV,MAAM,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;YACzC,CAAC;iBAAM,CAAC;gBACN,gBAAgB;gBAChB,MAAM,GAAG,YAAY,CAAC,cAAc,CAAC,SAAS,EAAE;oBAC9C,qBAAqB,EAAE,aAAa;oBACpC,qBAAqB,EAAE,aAAa;iBACrC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;aAAM,CAAC;YACN,WAAW;YACX,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;gBAC3B,UAAU;gBACV,MAAM,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;YACnC,CAAC;iBAAM,CAAC;gBACN,gBAAgB;gBAChB,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QAED,UAAU;QACV,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;IACvC,CAAC,CAAC;IAEF;;;;OAIG;IACH,MAAM,UAAU,GAAG,CAAC,GAAW,EAAW,EAAE;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC;IAEF;;;;OAIG;IACH,MAAM,YAAY,GAAG,CAAC,KAAc,EAAqB,EAAE;QACzD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,SAAS;YACT,OAAO,KAAK,CAAC,GAAG,CAAC,YAAY,CAAa,CAAC;QAC7C,CAAC;aAAM,CAAC;YACN,eAAe;YACf,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBACpD,aAAa;gBACb,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,oBAAoB;YACpB,uCAAuC;YACvC,MAAM,GAAG,GAAG,IAAA,2BAAiB,EAAC,KAAK,EAAE;gBACnC,aAAa;gBACb,QAAQ,EAAE,GAAG;aACd,CAAW,CAAC;YAEb,WAAW;YACX,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBACf,qBAAqB;gBACrB,OAAO,QAAQ,CAAC;YAClB,CAAC;YAED,SAAS;YACT,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAC;QACpC,CAAC;IACH,CAAC,CAAC;IAEF,QAAQ;IACR,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,kBAAe,uBAAuB,CAAC"}
+{"version":3,"file":"toFormattedNumberString.js","sourceRoot":"","sources":["../../src/object/toFormattedNumberString.ts"],"names":[],"mappings":";;;;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,4EAAoD;AAMpD,QAAQ;AACR,SAAS,uBAAuB,CAAC,MAAe,EAAE,OAAkE;IAChH,WAAW;IACX,MAAM,EAAE,aAAa,GAAG,IAAI,EAAE,QAAQ,GAAG,KAAK,EAAE,SAAS,GAAG,GAAG,EAAE,kBAAkB,GAAG,KAAK,EAAE,YAAY,EAAE,MAAM,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAEtJ;;;;;OAKG;IACH,MAAM,mBAAmB,GAAG,CAAC,cAAoD,EAAE,GAAW,EAAU,EAAE;QACtG,IAAI,OAAO,cAAc,KAAK,UAAU,EAAE,CAAC;YACvC,OAAO,cAAc,CAAC,GAAG,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,cAAc,CAAC;IAC1B,CAAC,CAAC;IAEF;;;;;OAKG;IACH,MAAM,eAAe,GAAG,CAAC,GAAW,EAAE,GAAW,EAAU,EAAE;QACzD,MAAM,eAAe,GAAG,mBAAmB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzD,MAAM,eAAe,GAAG,mBAAmB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzD,OAAO,GAAG,eAAe,GAAG,GAAG,GAAG,eAAe,EAAE,CAAC;IACxD,CAAC,CAAC;IAEF;;;;OAIG;IACH,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAU,EAAE;QAClD,QAAQ;QACR,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;YACZ,OAAO,eAAe,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAC3C,CAAC;QAED,UAAU;QACV,MAAM,YAAY,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAE5D,YAAY;QACZ,IAAI,MAAc,CAAC;QACnB,IAAI,kBAAkB,EAAE,CAAC;YACrB,UAAU;YACV,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;gBACzB,UAAU;gBACV,MAAM,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACJ,gBAAgB;gBAChB,MAAM,GAAG,YAAY,CAAC,cAAc,CAAC,SAAS,EAAE;oBAC5C,qBAAqB,EAAE,aAAa;oBACpC,qBAAqB,EAAE,aAAa;iBACvC,CAAC,CAAC;YACP,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,WAAW;YACX,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;gBACzB,UAAU;gBACV,MAAM,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;YACrC,CAAC;iBAAM,CAAC;gBACJ,gBAAgB;gBAChB,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YACjD,CAAC;QACL,CAAC;QAED,UAAU;QACV,OAAO,eAAe,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACjD,CAAC,CAAC;IAEF;;;;OAIG;IACH,MAAM,UAAU,GAAG,CAAC,GAAW,EAAW,EAAE;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC,CAAC;IAEF;;;;OAIG;IACH,MAAM,YAAY,GAAG,CAAC,KAAc,EAAqB,EAAE;QACvD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACvB,SAAS;YACT,OAAO,KAAK,CAAC,GAAG,CAAC,YAAY,CAAa,CAAC;QAC/C,CAAC;aAAM,CAAC;YACJ,eAAe;YACf,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClD,aAAa;gBACb,OAAO,eAAe,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACzC,CAAC;YAED,oBAAoB;YACpB,uCAAuC;YACvC,MAAM,GAAG,GAAG,IAAA,2BAAiB,EAAC,KAAK,EAAE;gBACjC,aAAa;gBACb,QAAQ,EAAE,GAAG;aAChB,CAAW,CAAC;YAEb,WAAW;YACX,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBACb,qBAAqB;gBACrB,OAAO,eAAe,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YAC1C,CAAC;YAED,SAAS;YACT,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAC;QACtC,CAAC;IACL,CAAC,CAAC;IAEF,QAAQ;IACR,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AAED,kBAAe,uBAAuB,CAAC"}

package/dist/types/object.d.ts

@@ -44,14 +44,14 @@ export interface ToFormattedNumberStringOptions extends CommonFormatOptions {
      */
     preProcessor?: (num: number) => number;
     /**
-     * 前缀，
+     * 前缀，可以是字符串或函数，
      * 默认''。
      */
-    prefix?: string;
+    prefix?: string | ((value: number) => string);
     /**
-     * 后缀，
+     * 后缀，可以是字符串或函数，
      * 默认''。
      */
-    suffix?: string;
+    suffix?: string | ((value: number) => string);
 }
 //# sourceMappingURL=object.d.ts.map

package/dist/types/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/types/object.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,mBAAmB;IACzE;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;IACvC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/types/object.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACjE;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,mBAAmB;IACvE;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;IACvC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;IAC9C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;CACjD"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@planarcat/js-toolkit",
-    "version": "1.4.0",
+    "version": "1.5.0",
     "description": "一个自用的带学习性质的（目前）现代化的 JavaScript/TypeScript 实用工具库，提供类型安全、高性能的常用函数，包括对象转换、日期处理、函数优化等开发常用工具。",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",