util-helpers 4.16.2 → 4.17.0

package/types/safeDate.d.ts

@@ -1,4 +1,26 @@
-export default safeDate;
+/**
+ * 创建一个 Date 实例日期对象，同 <a href="https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Date#%E5%8F%82%E6%95%B0">new Date()</a> <br/><br/>
+ *
+ * 规避了苹果设备浏览器不支持部分格式（例如，YYYY-MM-DD HH-mm 或 YYYY.MM.DD）。<br/>
+ * 如果参数为 undefined 正常返回 Date 。
+ *
+ * @static
+ * @alias module:Processor.safeDate
+ * @since 4.4.0
+ * @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 实例日期对象
+ * @example
+ *
+ * safeDate('2022-1-1'); // Sat Jan 01 2022 00:00:00 GMT+0800 (中国标准时间)
+ * safeDate('2022/1/1'); // Sat Jan 01 2022 00:00:00 GMT+0800 (中国标准时间)
+ * safeDate('2022.1.1'); // Sat Jan 01 2022 00:00:00 GMT+0800 (中国标准时间)
+ * safeDate('2022.1.1 11:11'); // Sat Jan 01 2022 11:11:00 GMT+0800 (中国标准时间)
+ * safeDate(99, 1); // Mon Feb 01 1999 00:00:00 GMT+0800 (中国标准时间)
+ * safeDate(1646711233171); // Tue Mar 08 2022 11:47:13 GMT+0800 (中国标准时间)
+ */
 declare function safeDate(): Date;
 declare function safeDate(value: number | string | Date): Date;
-declare function safeDate(year: number, monthIndex: number, date?: number | undefined, hours?: number | undefined, minutes?: number | undefined, seconds?: number | undefined, ms?: number | undefined): Date;
+declare function safeDate(year: number, monthIndex: number, date?: number, hours?: number, minutes?: number, seconds?: number, ms?: number): Date;
+export default safeDate;

package/types/setDataURLPrefix.d.ts

@@ -1,4 +1,3 @@
-export default setDataURLPrefix;
 /**
  * 设置 DataURL 前缀、MIME 类型、base64 标识。<br/>
  * 如果你需要获取DataURL 的 MIME 类型和数据本身，推荐使用 <a href="https://www.npmjs.com/package/data-urls">data-urls</a>。
@@ -6,10 +5,10 @@ export default setDataURLPrefix;
  * @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/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 {string} [mimeType="image/png"] MIME 类型
  * @param {boolean} [base64=true] 添加 base64 标识
  * @returns {string} DataURL 格式的字符串
  * @example
@@ -23,4 +22,5 @@ export default setDataURLPrefix;
  * setDataURLPrefix(data, '', false); // data:,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
  *
  */
-declare function setDataURLPrefix(data: string, mimetype?: string | undefined, base64?: boolean | undefined): string;
+declare function setDataURLPrefix(data: string, mimeType?: string, base64?: boolean): string;
+export default setDataURLPrefix;

package/types/strlen.d.ts

@@ -1,4 +1,3 @@
-export default strlen;
 /**
  * 获取字符长度。中文汉字占2个字符，英文占1个字符，特殊如emoji占4个字符。
  *
@@ -18,3 +17,4 @@ export default strlen;
  *
  */
 declare function strlen(str: string): number;
+export default strlen;

package/types/times.d.ts

@@ -1,4 +1,3 @@
-export default times;
 /**
  * 精确乘法，支持多个数相乘，乘数默认为 1 。
  *
@@ -9,9 +8,11 @@ export default times;
  * @returns {number} 乘积
  * @example
  *
+ * times(3); // 3
  * times(3, 0.6); // 1.8
  * times(3, 0.6, 2); // 3.6
  * times(3, 0.6, 2, 10); // 36
  *
  */
-declare function times(...nums: (number | string)[]): number;
+declare function times(...nums: (string | number)[]): number;
+export default times;

package/types/transformFieldNames.d.ts

@@ -1,18 +1,19 @@
-export default transformFieldNames;
+type NodeAssign = 'spread' | 'self';
+type ExchangeFieldNames<D extends any, F extends Record<string, keyof D>> = Omit<D, F[keyof F]> & {
+    [P in keyof F]: D[F[P]];
+};
+type TransformFieldNames<D extends any, F extends Record<string, any>, C extends string> = (C extends keyof D ? ExchangeFieldNames<Omit<D, C> & Record<C, TransformFieldNames<D, F, C>>, F> : ExchangeFieldNames<D, F>)[];
 /**
  * 转换字段名，返回一个转换字段后的值，不改变原值。
  *
  * @static
- * @alias module:Processor.transformFieldNames
+ * @alias module:Tree.transformFieldNames
  * @since 4.14.0
- * @template {*} D
- * @template {Record<string, keyof D>} F
- * @template {string} C
- * @param {D[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField
- * @param {F} fieldNames 字段名映射
- * @param {C} [childrenField] 子级数据字段名
+ * @param {object[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField
+ * @param {function} fieldNames 字段名映射
+ * @param {string} [childrenField] 子级数据字段名
  * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
- * @returns {import('./interface.type.js').TransformFieldNames<D, F, C>}
+ * @returns {object[]}
  * @example
  *
  * const options = [{code: '1', name: 'one'},{code:'2', name:'two'}];
@@ -32,4 +33,5 @@ export default transformFieldNames;
  * const newOptions4 = transformFieldNames(options3, {label: 'name', value: 'code', children: 'childs'}, 'childs');
  * // [{value: '1', label: 'one'},{value:'2', label:'two', children: [{value: '2-1', label:'two-one'}]}]
  */
-declare function transformFieldNames<D extends unknown, F extends Record<string, keyof D>, C extends string>(data: D[], fieldNames: F, childrenField?: C | undefined, nodeAssign?: "spread" | "self" | undefined): import("./interface.type.js").TransformFieldNames<D, F, C>;
+declare function transformFieldNames<D extends any, F extends Record<string, keyof D>, C extends string>(data: D[], fieldNames: F, childrenField?: C, nodeAssign?: NodeAssign): TransformFieldNames<D, F, C>;
+export default transformFieldNames;

package/types/treeToList.d.ts

@@ -1,4 +1,3 @@
-export default treeToList;
 /**
  * 树结构转列表数据
  *
@@ -18,3 +17,4 @@ export default treeToList;
  * // [{"id":"1","name":"首页","code":"trade","pid":null},{"id":"2","name":"交易管理","code":"trade","pid":null},{"id":"3","name":"交易查询","code":"trade-1","pid":"2"},{"id":"4","name":"交易查询-查询操作","code":"trade-1-1","pid":"3"},{"id":"5","name":"权限管理","code":"authorization","pid":null},{"id":"6","name":"角色管理","code":"authorization-1","pid":"5"},{"id":"7","name":"用户管理","code":"authorization-2","pid":"5"}]
  */
 declare function treeToList<T extends Record<string, any>, K extends keyof T, R extends Omit<T, K>>(tree: T[], childrenField: K): R[];
+export default treeToList;

package/types/utils/config.d.ts

@@ -1,6 +1,6 @@
-export namespace config {
-    const disableWarning: boolean;
-}
+declare const config: {
+    disableWarning: boolean;
+};
 /**
  * 设置禁止warning提示
  * @static
@@ -8,5 +8,6 @@ export namespace config {
  * @since 3.6.1
  * @param {boolean} bool 是否禁止warning提示
  */
-export function setDisableWarning(bool: boolean): void;
-export const version: string;
+declare function setDisableWarning(bool: boolean): void;
+declare const version: string;
+export { config, setDisableWarning, version };

package/types/utils/constants.d.ts

@@ -1,2 +1,2 @@
-export const MAX_SAFE_INTEGER: number;
-export const MIN_SAFE_INTEGER: number;
+export declare const MAX_SAFE_INTEGER: number;
+export declare const MIN_SAFE_INTEGER: number;

package/types/utils/convertToString.d.ts

@@ -1,4 +1,3 @@
-export default convertToString;
 /**
  * 转换为字符串
  *
@@ -6,3 +5,4 @@ export default convertToString;
  * @returns {string} 字符串
  */
 declare function convertToString(value: any): string;
+export default convertToString;

package/types/utils/devWarn.d.ts

@@ -1,7 +1,7 @@
-export default devWarn;
 /**
  * 打印警告信息
  *
  * @param  {any[]} args 打印的信息
  */
 declare function devWarn(...args: any[]): void;
+export default devWarn;

package/types/utils/math.util.d.ts

@@ -1,17 +1,23 @@
+/**
+ * 参考: https://github.com/nefe/number-precision/blob/master/src/index.ts
+ *
+ * 解决浮动运算问题，避免小数点后产生多位数和计算精度损失。
+ * 问题示例：2.3 + 2.4 = 4.699999999999999，1.0 - 0.9 = 0.09999999999999998
+ */
 /**
  * 将值转换为有效数值
  *
  * @param {*} value 要转换的值
  * @returns {number|string} 有效数值
  */
-export function transformEffectiveNumber(value: any): number | string;
+export declare function transformEffectiveNumber(value: any): string | number;
 /**
  * 是否为科学计数法数字
  *
  * @param {string} num 检查值
  * @returns {boolean}
  */
-export function isScientificNumber(num: string): boolean;
+export declare function isScientificNumber(num: string): boolean;
 /**
  * 把错误的数据转正
  *
@@ -22,34 +28,34 @@ export function isScientificNumber(num: string): boolean;
  *
  *  strip(0.09999999999999998)=0.1
  */
-export function strip(num: number, precision?: number | undefined): number;
+export declare function strip(num: number, precision?: number): number;
 /**
  * 计算数字的小数点长度，支持科学记数法
  *
  * @param {number|string} num 输入数
  * @returns {number} 小数点长度
  */
-export function digitLength(num: number | string): number;
+export declare function digitLength(num: number | string): number;
 /**
  * 把小数转成整数，支持科学计数法。如果是小数则放大成整数
  *
  * @param {number|string} num 输入数
  * @returns {number}
  */
-export function float2Fixed(num: number | string): number;
+export declare function float2Fixed(num: number | string): number;
 /**
  * 检测数字是否越界，如果越界给出提示
+ *
  * @param {number} num 输入数
- * @returns
  */
-export function checkBoundary(num: number): void;
+export declare function checkBoundary(num: number): void;
 /**
  * 去掉左边数字0
  *
  * @param {string} num 数字字符串
  * @returns {string}
  */
-export function trimLeftZero(num: string): string;
+export declare function trimLeftZero(num: string): string;
 /**
  * 科学计数法转换成普通数字
  *
@@ -60,4 +66,4 @@ export function trimLeftZero(num: string): string;
  * @param {string | number} num 科学计数法数字
  * @returns {string | number} 转换后的数字字符串
  */
-export function scientificToNumber(num: string | number): string | number;
+export declare function scientificToNumber(num: number | string): string | number;

package/types/utils/type/index.d.ts

@@ -18,4 +18,11 @@ import isWeakMap from './isWeakMap';
 import isSet from './isSet';
 import isWeakSet from './isWeakSet';
 import isUndefined from './isUndefined';
+/**
+ * 类型检测
+ *
+ * @module Type
+ * @ignore
+ * @since 1.1.0
+ */
 export { isArguments, isArray, isArrayBuffer, isBlob, isBoolean, isDate, isError, isFunction, isObject, isNull, isNaN, isNumber, isRegExp, isString, isSymbol, isMap, isWeakMap, isSet, isWeakSet, isUndefined };

package/types/utils/type/isArguments.d.ts

@@ -1,4 +1,3 @@
-export default isArguments;
 /**
  * 检查值是否为Arguments
  *
@@ -16,3 +15,4 @@ export default isArguments;
  * // => false
  */
 declare function isArguments(value: any): boolean;
+export default isArguments;

package/types/utils/type/isArray.d.ts

@@ -1,4 +1,3 @@
-export default isArray;
 /**
  * 检查值是否为Array
  *
@@ -16,3 +15,4 @@ export default isArray;
  * // => false
  */
 declare function isArray(value: any): boolean;
+export default isArray;

package/types/utils/type/isArrayBuffer.d.ts

@@ -1,4 +1,3 @@
-export default isArrayBuffer;
 /**
  * 检查值是否为ArrayBuffer对象
  *
@@ -19,3 +18,4 @@ export default isArrayBuffer;
  * // => false
  */
 declare function isArrayBuffer(value: any): boolean;
+export default isArrayBuffer;

package/types/utils/type/isBlob.d.ts

@@ -1,4 +1,3 @@
-export default isBlob;
 /**
  * 检查值是否为Blob对象<br/><br/>
  *
@@ -21,3 +20,4 @@ export default isBlob;
  * // => false
  */
 declare function isBlob(value: any): boolean;
+export default isBlob;

package/types/utils/type/isBoolean.d.ts

@@ -1,4 +1,3 @@
-export default isBoolean;
 /**
  * 检查值是否为Boolean
  *
@@ -16,3 +15,4 @@ export default isBoolean;
  * // => false
  */
 declare function isBoolean(value: any): boolean;
+export default isBoolean;

package/types/utils/type/isDate.d.ts

@@ -1,4 +1,3 @@
-export default isDate;
 /**
  * 检查值是否为Date
  *
@@ -16,3 +15,4 @@ export default isDate;
  * // => false
  */
 declare function isDate(value: any): boolean;
+export default isDate;

package/types/utils/type/isError.d.ts

@@ -1,4 +1,3 @@
-export default isError;
 /**
  * 检查值是否为Error、EvalError、RangeError、ReferenceError、SyntaxError、TypeError、URIError|DOMException
  *
@@ -16,3 +15,4 @@ export default isError;
  * // => false
  */
 declare function isError(value: any): boolean;
+export default isError;

package/types/utils/type/isFunction.d.ts

@@ -1,4 +1,3 @@
-export default isFunction;
 /**
  * 检查值是否为Function|AsyncFunction|GeneratorFunction|Proxy
  *
@@ -16,3 +15,4 @@ export default isFunction;
  * // => false
  */
 declare function isFunction(value: any): boolean;
+export default isFunction;

package/types/utils/type/isMap.d.ts

@@ -1,4 +1,3 @@
-export default isMap;
 /**
  * 检查值是否为Map
  *
@@ -16,3 +15,4 @@ export default isMap;
  * // => false
  */
 declare function isMap(value: any): boolean;
+export default isMap;

package/types/utils/type/isNaN.d.ts

@@ -1,4 +1,3 @@
-export default _isNaN;
 /**
  * 检查值是否为NaN
  *
@@ -16,3 +15,4 @@ export default _isNaN;
  * // => false
  */
 declare function _isNaN(value: any): boolean;
+export default _isNaN;

package/types/utils/type/isNil.d.ts

@@ -1,4 +1,3 @@
-export default isNil;
 /**
  * 检查值是否为 undefined 或 null
  *
@@ -9,3 +8,4 @@ export default isNil;
  * @returns {boolean} 是否为 undefined 或 null
  */
 declare function isNil(value: any): boolean;
+export default isNil;

package/types/utils/type/isNull.d.ts

@@ -1,4 +1,3 @@
-export default isNull;
 /**
  * 检查值是否为Null
  *
@@ -16,3 +15,4 @@ export default isNull;
  * // => false
  */
 declare function isNull(value: any): boolean;
+export default isNull;

package/types/utils/type/isNumber.d.ts

@@ -1,4 +1,3 @@
-export default isNumber;
 /**
  * 检查值是否为Number
  *
@@ -25,3 +24,4 @@ export default isNumber;
  * // => false
  */
 declare function isNumber(value: any): boolean;
+export default isNumber;

package/types/utils/type/isObject.d.ts

@@ -1,4 +1,3 @@
-export default isObject;
 /**
  * 检查值是否为Object
  *
@@ -19,3 +18,4 @@ export default isObject;
  * // => false
  */
 declare function isObject(value: any): boolean;
+export default isObject;

package/types/utils/type/isRegExp.d.ts

@@ -1,4 +1,3 @@
-export default isRegExp;
 /**
  * 检查值是否为RegExp
  *
@@ -16,3 +15,4 @@ export default isRegExp;
  * // => false
  */
 declare function isRegExp(value: any): boolean;
+export default isRegExp;

package/types/utils/type/isSet.d.ts

@@ -1,4 +1,3 @@
-export default isSet;
 /**
  * 检查值是否为Set
  *
@@ -16,3 +15,4 @@ export default isSet;
  * // => false
  */
 declare function isSet(value: any): boolean;
+export default isSet;

package/types/utils/type/isString.d.ts

@@ -1,4 +1,3 @@
-export default isString;
 /**
  * 检查值是否为String
  *
@@ -16,3 +15,4 @@ export default isString;
  * // => false
  */
 declare function isString(value: any): boolean;
+export default isString;

package/types/utils/type/isSymbol.d.ts

@@ -1,4 +1,3 @@
-export default isSymbol;
 /**
  * 检查值是否为Symbol
  *
@@ -16,3 +15,4 @@ export default isSymbol;
  * // => false
  */
 declare function isSymbol(value: any): boolean;
+export default isSymbol;

package/types/utils/type/isType.d.ts

@@ -1,4 +1,3 @@
-export default isType;
 /**
  * 检测值的 `toString` 类型
  *
@@ -9,3 +8,4 @@ export default isType;
  * @returns {boolean} 返回值的 `toString` 类型是否匹配
  */
 declare function isType(value: any, typename: string): boolean;
+export default isType;

package/types/utils/type/isUndefined.d.ts

@@ -1,4 +1,3 @@
-export default isUndefined;
 /**
  * 检查值是否为Undefined
  *
@@ -19,3 +18,4 @@ export default isUndefined;
  * // => false
  */
 declare function isUndefined(value: any): boolean;
+export default isUndefined;

package/types/utils/type/isWeakMap.d.ts

@@ -1,4 +1,3 @@
-export default isWeakMap;
 /**
  * 检查值是否为WeakMap
  *
@@ -16,3 +15,4 @@ export default isWeakMap;
  * // => false
  */
 declare function isWeakMap(value: any): boolean;
+export default isWeakMap;

package/types/utils/type/isWeakSet.d.ts

@@ -1,4 +1,3 @@
-export default isWeakSet;
 /**
  * 检查值是否为WeakSet
  *
@@ -16,3 +15,4 @@ export default isWeakSet;
  * // => false
  */
 declare function isWeakSet(value: any): boolean;
+export default isWeakSet;

package/types/validatePassword.d.ts

@@ -1,45 +1,7 @@
-export default validatePassword;
-/**
- * - 验证密码的包含内容
- */
-export type PasswordContaines = {
-    /**
-     * - 包含数字
-     */
-    number: boolean;
-    /**
-     * - 包含小写字母
-     */
-    lowerCaseLetter: boolean;
-    /**
-     * - 包含大写字母
-     */
-    upperCaseLetter: boolean;
-    /**
-     * - 包含特殊字符
-     */
-    specialCharacter: boolean;
-    /**
-     * - 包含非法字符
-     */
-    unallowableCharacter: boolean;
-};
-/**
- * - 验证结果
- */
-export type ValidatePasswordReturn = {
-    /**
-     * - 验证结果，根据密码强度、是否包含非法字符得出
-     */
-    validated: boolean;
-    /**
-     * - 强度级别，包含数字/大小写字母/特殊字符
-     */
-    level: number;
-    /**
-     * - 包含内容
-     */
-    containes: PasswordContaines;
+type Options = {
+    level?: number;
+    ignoreCase?: boolean;
+    special?: string;
 };
 /**
  * @typedef {Object} PasswordContaines - 验证密码的包含内容
@@ -61,7 +23,7 @@ export type ValidatePasswordReturn = {
  * @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-包含三种字符。（大写字母、小写字母、数字、特殊字符）
@@ -127,8 +89,15 @@ export type ValidatePasswordReturn = {
  *   }
  * }
  */
-declare function validatePassword(value: string, options?: {
-    level?: number | undefined;
-    ignoreCase?: boolean | undefined;
-    special?: string | undefined;
-} | undefined): ValidatePasswordReturn;
+declare function validatePassword(value: string, options?: Options): {
+    validated: boolean;
+    level: number;
+    containes: {
+        number: boolean;
+        lowerCaseLetter: boolean;
+        upperCaseLetter: boolean;
+        specialCharacter: boolean;
+        unallowableCharacter: boolean;
+    };
+};
+export default validatePassword;

package/types/waitTime.d.ts

@@ -1,4 +1,3 @@
-export default waitTime;
 /**
  * 等待时间返回 Promise 。常用于异步方法中延时。
  *
@@ -19,4 +18,5 @@ export default waitTime;
  * });
  *
  */
-declare function waitTime(time?: number | undefined): Promise<void>;
+declare function waitTime(time?: number): Promise<unknown>;
+export default waitTime;