util-helpers 4.15.3 → 4.16.1

package/types/numberToChinese.d.ts

@@ -1,7 +1,8 @@
 export default numberToChinese;
 /**
- * 数字转中文数字
- * 不在安全数字 -9007199254740991～9007199254740991 内，处理会有异常
+ * 数字转中文数字<br/><br/>
+ *
+ * 如果数字不在安全数字 -9007199254740991～9007199254740991 范围内，处理会有异常。
  *
  * @static
  * @alias module:Processor.numberToChinese

package/types/parseIdCard.d.ts

@@ -76,9 +76,9 @@ export type IdCardInfo = {
  * @static
  * @alias module:Processor.parseIdCard
  * @since 4.0.0
- * @see 参考 {@link https://baike.baidu.com/item/居民身份证号码|居民身份证号码}
+ * @see {@link https://baike.baidu.com/item/居民身份证号码|居民身份证号码}
  * @param {string} id 身份证号码，支持15位
- * @returns {null|IdCardInfo} null 或 省份、生日、性别，省/市/区/年/月/日/性别编码
+ * @returns {IdCardInfo | null} 省份、生日、性别，省/市/区/年/月/日/性别编码。如果解析失败将返回 null 。
  * @example
  *
  * parseIdCard('123456789123456'); // null
@@ -104,4 +104,4 @@ export type IdCardInfo = {
  * }
  *
  */
-declare function parseIdCard(id: string): null | IdCardInfo;
+declare function parseIdCard(id: string): IdCardInfo | null;

package/types/safeDate.d.ts

@@ -1,24 +1,4 @@
 export default safeDate;
-/**
- * 创建一个 Date 实例日期对象，同 new Date() 。<br/>
- * 规避了苹果设备浏览器不支持部分格式（YYYY-MM-DD HH-mm 或 YYYY.MM.DD）。
- *
- * @static
- * @alias module:Processor.safeDate
- * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Date|Date}
- * @since 4.4.0
- * @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(value?: string | number | Date | undefined, ...args: number[]): Date;
+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;

package/types/setDataURLPrefix.d.ts

@@ -5,9 +5,9 @@ export default setDataURLPrefix;
  *
  * @static
  * @alias module:Processor.setDataURLPrefix
- * @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}
  * @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}
  * @param {string} data 数据本身
  * @param {string} [mimetype="image/png"] MIME 类型
  * @param {boolean} [base64=true] 添加 base64 标识

package/types/transformFieldNames.d.ts

@@ -12,7 +12,7 @@ export default transformFieldNames;
  * @param {F} fieldNames 字段名映射
  * @param {C} [childrenField] 子级数据字段名
  * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
- * @returns {import('./transformFieldNames.type.js').TransformFieldNames<D, F, C>}
+ * @returns {import('./interface.type.js').TransformFieldNames<D, F, C>}
  * @example
  *
  * const options = [{code: '1', name: 'one'},{code:'2', name:'two'}];
@@ -32,4 +32,4 @@ 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("./transformFieldNames.type.js").TransformFieldNames<D, F, C>;
+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>;

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

@@ -1,19 +1,21 @@
-import isArguments from "./isArguments";
-import isArray from "./isArray";
-import isBoolean from "./isBoolean";
-import isDate from "./isDate";
-import isError from "./isError";
-import isFunction from "./isFunction";
-import isObject from "./isObject";
-import isNull from "./isNull";
-import isNaN from "./isNaN";
-import isNumber from "./isNumber";
-import isRegExp from "./isRegExp";
-import isString from "./isString";
-import isSymbol from "./isSymbol";
-import isMap from "./isMap";
-import isWeakMap from "./isWeakMap";
-import isSet from "./isSet";
-import isWeakSet from "./isWeakSet";
-import isUndefined from "./isUndefined";
-export { isArguments, isArray, isBoolean, isDate, isError, isFunction, isObject, isNull, isNaN, isNumber, isRegExp, isString, isSymbol, isMap, isWeakMap, isSet, isWeakSet, isUndefined };
+import isArguments from './isArguments';
+import isArray from './isArray';
+import isArrayBuffer from './isArrayBuffer';
+import isBlob from './isBlob';
+import isBoolean from './isBoolean';
+import isDate from './isDate';
+import isError from './isError';
+import isFunction from './isFunction';
+import isObject from './isObject';
+import isNull from './isNull';
+import isNaN from './isNaN';
+import isNumber from './isNumber';
+import isRegExp from './isRegExp';
+import isString from './isString';
+import isSymbol from './isSymbol';
+import isMap from './isMap';
+import isWeakMap from './isWeakMap';
+import isSet from './isSet';
+import isWeakSet from './isWeakSet';
+import isUndefined from './isUndefined';
+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/isArrayBuffer.d.ts

@@ -0,0 +1,21 @@
+export default isArrayBuffer;
+/**
+ * 检查值是否为ArrayBuffer对象
+ *
+ * @static
+ * @alias module:Type.isArrayBuffer
+ * @since 4.16.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为ArrayBuffer对象
+ * @example
+ *
+ * isArrayBuffer(new ArrayBuffer(8))
+ * // => true
+ *
+ * isArrayBuffer({})
+ * // => false
+ *
+ * isArrayBuffer('2012')
+ * // => false
+ */
+declare function isArrayBuffer(value: any): boolean;

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

@@ -0,0 +1,23 @@
+export default isBlob;
+/**
+ * 检查值是否为Blob对象<br/><br/>
+ *
+ * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
+ *
+ * @static
+ * @alias module:Type.isBlob
+ * @since 4.16.0
+ * @param {*} value 检查值
+ * @returns {boolean} 是否为Blob对象
+ * @example
+ *
+ * isBlob(new Blob(['a']))
+ * // => true
+ *
+ * isBlob({})
+ * // => false
+ *
+ * isBlob('2012')
+ * // => false
+ */
+declare function isBlob(value: any): boolean;

package/types/validatePassword.d.ts

@@ -58,10 +58,10 @@ export type ValidatePasswordReturn = {
 /**
  * 验证密码（数字、大小写字母、特殊字符、非法字符）
  *
- * @see 参考 {@link https://baike.baidu.com/item/ASCII#3|ASCII}
  * @static
  * @alias module:Validator.validatePassword
  * @since 3.7.0
+ * @see {@link https://baike.baidu.com/item/ASCII#3|ASCII}
  * @param {string} value 要检测的值
  * @param {Object} [options] 配置项
  * @param {number} [options.level=2] 密码强度 1-包含一种字符 2-包含两种字符 3-包含三种字符。（大写字母、小写字母、数字、特殊字符）

package/esm/transformFieldNames.doc.js

@@ -1,35 +0,0 @@
-/* eslint-disable no-unused-vars */
-// 该文件用于 jsdoc 生成文件。因为一些 typescript 语法， jsdoc 不支持，导致生成文档报错。
-
-/**
- * 转换字段名，返回一个转换字段后的值，不改变原值。
- * 
- * @static
- * @alias module:Tree.transformFieldNames
- * @since 4.14.0
- * @param {object[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField
- * @param {object} fieldNames 字段名映射
- * @param {string} [childrenField] 子级数据字段名
- * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
- * @returns {object[]}
- * @example
- * 
- * const options = [{code: '1', name: 'one'},{code:'2', name:'two'}];
- * const newOptions = transformFieldNames(options, {label: 'name', value: 'code'});
- * // [{value: '1', label: 'one'},{value:'2', label:'two'}]
- * 
- * // 嵌套数据，指定子级字段名 children
- * const options2 = [{code: '1', name: 'one'},{code:'2', name:'two', children: [{code:'2-1', name:'two-one', children: [{code: '2-1-1', name:'two-one-one'}]}]}];
- * const newOptions2 = transformFieldNames(options2, {label: 'name', value: 'code'}, 'children');
- * // [{value: '1', label: 'one'},{value:'2', label:'two', children: [{value: '2-1', label:'two-one', children: [{value: '2-1-1', label:'two-one-one'}]}]}]
- * 
- * const options3 = [{code: '1', name: 'one'},{code:'2', name:'two', childs: [{code:'2-1', name:'two-one'}]}];
- * const newOptions3 = transformFieldNames(options3, {label: 'name', value: 'code'}, 'childs');
- * // [{value: '1', label: 'one'},{value:'2', label:'two', childs: [{value: '2-1', label:'two-one'}]}]
- * 
- * // 嵌套数据，并替换子集字段名
- * 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'}]}]
- */
-function transformFieldNames(data, fieldNames, childrenField) {}
-export default transformFieldNames;

package/lib/transformFieldNames.doc.js

@@ -1,42 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-/* eslint-disable no-unused-vars */
-// 该文件用于 jsdoc 生成文件。因为一些 typescript 语法， jsdoc 不支持，导致生成文档报错。
-
-/**
- * 转换字段名，返回一个转换字段后的值，不改变原值。
- * 
- * @static
- * @alias module:Tree.transformFieldNames
- * @since 4.14.0
- * @param {object[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField
- * @param {object} fieldNames 字段名映射
- * @param {string} [childrenField] 子级数据字段名
- * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
- * @returns {object[]}
- * @example
- * 
- * const options = [{code: '1', name: 'one'},{code:'2', name:'two'}];
- * const newOptions = transformFieldNames(options, {label: 'name', value: 'code'});
- * // [{value: '1', label: 'one'},{value:'2', label:'two'}]
- * 
- * // 嵌套数据，指定子级字段名 children
- * const options2 = [{code: '1', name: 'one'},{code:'2', name:'two', children: [{code:'2-1', name:'two-one', children: [{code: '2-1-1', name:'two-one-one'}]}]}];
- * const newOptions2 = transformFieldNames(options2, {label: 'name', value: 'code'}, 'children');
- * // [{value: '1', label: 'one'},{value:'2', label:'two', children: [{value: '2-1', label:'two-one', children: [{value: '2-1-1', label:'two-one-one'}]}]}]
- * 
- * const options3 = [{code: '1', name: 'one'},{code:'2', name:'two', childs: [{code:'2-1', name:'two-one'}]}];
- * const newOptions3 = transformFieldNames(options3, {label: 'name', value: 'code'}, 'childs');
- * // [{value: '1', label: 'one'},{value:'2', label:'two', childs: [{value: '2-1', label:'two-one'}]}]
- * 
- * // 嵌套数据，并替换子集字段名
- * 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'}]}]
- */
-function transformFieldNames(data, fieldNames, childrenField) {}
-var _default = transformFieldNames;
-exports["default"] = _default;