nhanh-pure-function 3.0.6-beta.5 → 3.0.6-beta.7

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 ADMINnhanh
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 ADMINnhanh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,19 +1,19 @@
-# nhanh-pure-function
-
-纯函数工具库，提供了一些常用的纯函数工具，帮助您在 JavaScript/TypeScript 项目中更高效地处理数据。
-
-## 安装
-
-您可以通过 npm 安装该库：
-
-```bash
-npm install nhanh-pure-function
-```
-
-## 功能介绍
-
-`nhanh-pure-function` 库旨在提供一系列纯函数，这些函数在处理数据时不会产生副作用，确保函数的输入和输出之间的映射关系是确定的。这使得代码更易于测试、维护和复用。
-
-## 许可证
-
+# nhanh-pure-function
+
+纯函数工具库，提供了一些常用的纯函数工具，帮助您在 JavaScript/TypeScript 项目中更高效地处理数据。
+
+## 安装
+
+您可以通过 npm 安装该库：
+
+```bash
+npm install nhanh-pure-function
+```
+
+## 功能介绍
+
+`nhanh-pure-function` 库旨在提供一系列纯函数，这些函数在处理数据时不会产生副作用，确保函数的输入和输出之间的映射关系是确定的。这使得代码更易于测试、维护和复用。
+
+## 许可证
+
 [MIT](https://opensource.org/licenses/MIT)

package/dist/Format/index.d.ts

@@ -73,3 +73,39 @@ export declare function _Format_CamelCase(str: string, isRemoveDelimiter?: boole
  * @returns 裁减后的字符串
  */
 export declare function _Format_ExcludeSubstring(inputString: string, substringToDelete: string, delimiter?: string): string;
+/**
+ * 处理不可见字符的转义和还原
+ * @param {string} str - 要处理的字符串
+ * @param {boolean} escape - true表示转义（默认），false表示还原
+ * @returns {string} 处理后的字符串
+ */
+export declare function _Format_ToggleInvisibleChars(str: string, escape?: boolean): string;
+declare const UnitConfigs: readonly [readonly ["年", number], readonly ["月", number], readonly ["周", number], readonly ["天", number], readonly ["时", number], readonly ["分", number], readonly ["秒", 1000], readonly ["毫秒", 1]];
+type UnitName = (typeof UnitConfigs)[number][0];
+/**
+ * 格式化毫秒数为易读的时间单位（基于固定换算规则）
+ * @param ms 待格式化的毫秒数（需为非负整数）
+ * @param maxUnit 最大单位限制（可选，如传入"天"则最大只显示到天，不显示年/月/周）
+ *                可选值："年"|"月"|"周"|"天"|"时"|"分"|"秒"|"毫秒"
+ * @returns 格式化后的时间字符串（如 1.3秒、300毫秒、1,234年）
+ * @description
+ *  1. 单位换算规则（固定值，非自然时间）：
+ *     - 1年 = 365天（忽略闰年差异）
+ *     - 1月 = 30天（忽略实际月份天数差异）
+ *     - 1周 = 7天，1天 = 24小时，1小时 = 60分钟，1分钟 = 60秒，1秒 = 1000毫秒
+ *  2. 格式化逻辑：
+ *     - 自动匹配不超过最大单位限制的最优单位（数值≥单位阈值时使用该单位）
+ *     - 非整数数值保留1位小数（如1.3秒），整数自动去除末尾.0（如1秒而非1.0秒）
+ *     - "年"单位数值会自动应用千分位格式化（如1,234年）
+ *  3. 输入校验：非整数或负数会返回"0毫秒"
+ */
+export declare function _Format_MillisecondToReadable(ms: number, maxUnit?: UnitName): string;
+/**
+ * 将数组按指定长度分割成多个子数组
+ * @param arr 要分割的原始数组
+ * @param size 每个子数组的长度
+ * @returns 分割后的二维数组
+ * @throws 当size小于1时抛出错误
+ */
+export declare function _Format_ChunkArray<T>(arr: T[], size: number): T[][];
+export {};

package/dist/Types/index.d.ts

@@ -8,7 +8,7 @@
  * type RequiredName = RequiredBy<User, 'name'>
  * // 结果：{ name: string; age?: number; id: string }
  */
-export type RequiredBy<T, K extends keyof T> = Required<Pick<T, K>> & Omit<T, K>;
+export type _Type_RequiredBy<T, K extends keyof T> = Required<Pick<T, K>> & Omit<T, K>;
 /**
  * 将类型 T 中指定的属性 K 改为可选，其他属性保持原有状态（必填/可选）
  * @template T - 原始类型
@@ -19,4 +19,16 @@ export type RequiredBy<T, K extends keyof T> = Required<Pick<T, K>> & Omit<T, K>
  * type OptionalAge = PartialBy<User, 'age'>
  * // 结果：{ name: string; age?: number; id?: string }
  */
-export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export type _Type_PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+/**
+ * 递归将类型T的所有属性（包括嵌套对象的属性）转为可选
+ * @template T - 要处理的基础类型
+ * @description 与TypeScript内置的Partial不同，DeepPartial会对嵌套对象进行递归处理，
+ *              使所有层级的属性都变为可选。适用于需要部分更新对象且允许深层属性缺失的场景
+ */
+export type _Type_DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+export type _Type_Mutable<T> = {
+    -readonly [P in keyof T]: T[P];
+};