util-helpers 5.2.0 → 5.2.2

package/types/index.d.ts

@@ -2,7 +2,6 @@
  * 数据验证
  *
  * @module Validator
- * @since 1.1.0
  */
 export { default as isMobile } from './isMobile';
 export { default as isTelephone } from './isTelephone';
@@ -30,7 +29,6 @@ export { default as isValidNumber } from './isValidNumber';
  * 数据处理
  *
  * @module Processor
- * @since 1.1.0
  */
 export { default as formatMoney } from './formatMoney';
 export { default as formatBankCard } from './formatBankCard';
@@ -38,8 +36,6 @@ export { default as replaceChar } from './replaceChar';
 export { default as numberToChinese } from './numberToChinese';
 export { default as bytesToSize } from './bytesToSize';
 export { default as parseIdCard } from './parseIdCard';
-export { default as fileReader } from './fileReader';
-export { default as dataURLToBlob } from './dataURLToBlob';
 export { default as setDataURLPrefix } from './setDataURLPrefix';
 export { default as safeDate } from './safeDate';
 export { default as formatMobile } from './formatMobile';
@@ -49,7 +45,6 @@ export { default as transformObjectValue } from './transformObjectValue';
  * 数学计算，修正浮点数计算问题
  *
  * @module Math
- * @since 3.1.0
  * @see {@link https://github.com/camsong/blog/issues/9 | JavaScript 浮点数陷阱及解法}
  * @see {@link https://2zbuy.csb.app/ | JS浮点数计算测试}
  * @example
@@ -92,16 +87,18 @@ export { default as round } from './round';
 export { default as gcd } from './gcd';
 export { default as lcm } from './lcm';
 /**
- * 其他
+ * 浏览器
  *
- * @module Other
- * @since 4.2.0
+ * <em style="font-weight: bold;">下列方法仅适用于浏览器端。</em>
+ *
+ * @module Browser
  */
 export { default as ajax } from './ajax';
-export { default as calculateCursorPosition } from './calculateCursorPosition';
 export { default as checkFileType } from './checkFileType';
 export { default as compressImage } from './compressImage';
+export { default as dataURLToBlob } from './dataURLToBlob';
 export { default as download } from './download';
+export { default as fileReader } from './fileReader';
 export { default as getFileBlob } from './getFileBlob';
 export { default as getFileType } from './getFileType';
 export { default as getImageInfo } from './getImageInfo';
@@ -109,13 +106,18 @@ export { default as getMimeType } from './getMimeType';
 export { default as loadImage } from './loadImage';
 export { default as loadImageWithBlob } from './loadImageWithBlob';
 export { default as loadScript } from './loadScript';
+/**
+ * 其他
+ *
+ * @module Other
+ */
+export { default as calculateCursorPosition } from './calculateCursorPosition';
 export { default as randomString } from './randomString';
 export { default as strlen } from './strlen';
 /**
  * 树结构数据查询、过滤、转换等处理方法
  *
  * @module Tree
- * @since 4.14.0
  */
 export { default as transformFieldNames } from './transformFieldNames';
 export { default as listToTree } from './listToTree';

package/types/isBankCard.d.ts

@@ -5,7 +5,6 @@ type Options = {
 /**
  * 检测值是否为银行卡号。正常模式（非0开头，10-21位数字）宽松模式（8-30位数字）
  *
- * @static
  * @alias module:Validator.isBankCard
  * @since 1.1.0
  * @see {@link https://kf.qq.com/faq/170112ABnm6b170112FvquAn.html | 常用银行账号位数参考}

package/types/isBusinessLicense.d.ts

@@ -4,7 +4,6 @@ type Options = {
 /**
  * 检测值是否为营业执照号，也叫工商注册号。由14位数字本体码和1位数字校验码组成，其中本体码从左至右依次为：6位首次登记机关码、8位顺序码。
  *
- * @static
  * @alias module:Validator.isBusinessLicense
  * @since 3.5.0
  * @see {@link https://wenku.baidu.com/view/19873704cc1755270722087c.html | GS15—2006 工商行政管理市场主体注册号编制规则}

package/types/isChinese.d.ts

@@ -5,7 +5,6 @@ type Options = {
 /**
  * 检测值是否为中文
  *
- * @static
  * @alias module:Validator.isChinese
  * @since 1.1.0
  * @see {@link http://www.unicode.org/reports/tr38/#BlockListing | 4.4 Listing of Characters Covered by the Unihan Database}

package/types/isEmail.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为Email
  *
- * @static
  * @alias module:Validator.isEmail
  * @since 1.1.0
  * @param {*} value 要检测的值

package/types/isHMCard.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为港澳居民来往内地通行证，俗称回乡证或回乡卡。
  *
- * @static
  * @alias module:Validator.isHMCard
  * @since 4.0.0
  * @see {@link https://zh.wikipedia.org/wiki/港澳居民来往内地通行证 | 港澳居民来往内地通行证}

package/types/isIPv4.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为ipv4
  *
- * @static
  * @alias module:Validator.isIPv4
  * @since 1.1.0
  * @param {*} value 要检测的值

package/types/isIPv6.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为ipv6
  *
- * @static
  * @alias module:Validator.isIPv6
  * @since 1.1.0
  * @param {*} value 要检测的值

package/types/isIdCard.d.ts

@@ -7,7 +7,6 @@ type Options = {
  *
  * 宽松模式下，支持15位身份证号码。
  *
- * @static
  * @alias module:Validator.isIdCard
  * @since 1.1.0
  * @see {@link https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码 | 中华人民共和国公民身份号码}

package/types/isMobile.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为手机号码
  *
- * @static
  * @alias module:Validator.isMobile
  * @since 1.1.0
  * @param {*} value 要检测的值

package/types/isPassport.d.ts

@@ -2,7 +2,6 @@
  * 检测值是否为护照号
  * 支持普通护照(E*)、外交护照(DE)、公务护照(SE)、公务普通护照(PE)、香港特区护照(K/KJ/H*)、澳门特区护照(MA/MB/M*)，注意不区分大小写
  *
- * @static
  * @alias module:Validator.isPassport
  * @since 1.1.0
  * @see {@link https://zh.wikipedia.org/wiki/中华人民共和国护照#个人资料页 | 中华人民共和国护照#个人资料页}

package/types/isPassword.d.ts

@@ -4,7 +4,6 @@ import validatePassword from './validatePassword';
  * <p><strong>注意：该校验只校验是否存在不同字符(大小写字母、数字、特殊符号)，不判断长度。</strong></p>
  * <p><i>如果需要更细致的验证，请使用 <a href="#.validatePassword">validatePassword</a></i></p>
  *
- * @static
  * @alias module:Validator.isPassword
  * @requires module:Validator.validatePassword
  * @since 1.1.0

package/types/isPostcode.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为邮政编码，6位数字
  *
- * @static
  * @alias module:Validator.isPostcode
  * @since 1.1.0
  * @param {*} value 要检测的值

package/types/isQQ.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为QQ号，非0开头，5至11位数字
  *
- * @static
  * @alias module:Validator.isQQ
  * @since 1.1.0
  * @param {*} value 要检测的值

package/types/isSocialCreditCode.d.ts

@@ -4,7 +4,6 @@ type Options = {
 /**
  * 检测值是否为统一社会信用代码，也叫三证合一组织代码。由18位数字和大写字母组成，不使用I、O、Z、S、V。
  *
- * @static
  * @alias module:Validator.isSocialCreditCode
  * @since 1.1.0
  * @see {@link https://zh.wikisource.org/zh-hans/GB_32100-2015_法人和其他组织统一社会信用代码编码规则 | GB 32100-2015 法人和其他组织统一社会信用代码编码规则}

package/types/isSwiftCode.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为 Swift Code。8位或11位，前6位为大写字母，7-8位为大写字母或数字，9-11位为可选的大写字母或数字。
  *
- * @static
  * @alias module:Validator.isSwiftCode
  * @since 4.9.0
  * @see {@link https://zh.wikipedia.org/wiki/ISO_9362 | ISO 9362}

package/types/isTWCard.d.ts

@@ -4,7 +4,6 @@ type Options = {
 /**
  * 检测值是否为台湾居民来往大陆通行证，俗称台胞证。
  *
- * @static
  * @alias module:Validator.isTWCard
  * @since 4.0.0
  * @see {@link https://zh.wikipedia.org/wiki/台湾居民来往大陆通行证 | 台湾居民来往大陆通行证}

package/types/isTelephone.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为固定电话
  *
- * @static
  * @alias module:Validator.isTelephone
  * @since 1.1.0
  * @param {*} value 要检测的值

package/types/isUrl.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为url
  *
- * @static
  * @alias module:Validator.isUrl
  * @since 3.4.0
  * @see {@link https://zh.wikipedia.org/wiki/统一资源定位符 | 统一资源定位符}

package/types/isValidNumber.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为有效数值，支持隐式转换。如果返回 true ，表示可以通过 Number() 转为数字。
  *
- * @static
  * @alias module:Validator.isValidNumber
  * @since 4.17.2
  * @param {*} value 待检测的值

package/types/isVehicle.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为车牌号，支持新能源和非新能源车牌
  *
- * @static
  * @alias module:Validator.isVehicle
  * @since 1.1.0
  * @see {@link https://baike.baidu.com/item/车牌号 | 车牌号}

package/types/isWX.d.ts

@@ -1,7 +1,6 @@
 /**
  * 检测值是否为微信号
  *
- * @static
  * @alias module:Validator.isWX
  * @since 1.1.0
  * @param {*} value 要检测的值

package/types/lcm.d.ts

@@ -11,7 +11,6 @@
  * 6. 如果参数为负数，将转为绝对值的正数。
  * 7. 如果参数包含小数点，将转为四舍五入的整数。
  *
- * @static
  * @alias module:Math.lcm
  * @since 4.20.0
  * @see {@link https://baike.baidu.com/item/最小公倍数 | 最小公倍数}

package/types/listToTree.d.ts

@@ -9,7 +9,6 @@ type Options = {
 /**
  * 列表数据转树结构
  *
- * @static
  * @alias module:Tree.listToTree
  * @since 4.14.0
  * @param {Object[]} list 列表数据

package/types/loadImage.d.ts

@@ -3,8 +3,7 @@
  *
  * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
  *
- * @static
- * @alias module:Other.loadImage
+ * @alias module:Browser.loadImage
  * @since 4.20.0
  * @param {string | Blob} img 图片地址或 blob 对象
  * @returns {Promise<HTMLImageElement>} HTML图片元素

package/types/loadImageWithBlob.d.ts

@@ -12,7 +12,7 @@ import getFileBlob from './getFileBlob';
  * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
  *
  * @method
- * @alias module:Other.loadImageWithBlob
+ * @alias module:Browser.loadImageWithBlob
  * @since 4.20.0
  * @param {string | Blob} img 图片地址或 blob 对象
  * @param {AjaxOptions} [ajaxOptions] ajax 请求配置项，当传入的图片为字符串时才会触发请求。
@@ -20,7 +20,8 @@ import getFileBlob from './getFileBlob';
  * @example
  *
  * loadImage(file).then(({image, blob})=>{
- *    // do something
+ *   console.log(image, blob);
+ *   // HTMLImageElement {} Blob {}
  * });
  *
  * loadImage('https://dummyimage.com/200x300').then(({image, blob})=>{

package/types/loadScript.d.ts

@@ -7,8 +7,7 @@ type ScriptAttribute = Pick<HTMLScriptElement, 'async' | 'crossOrigin' | 'defer'
  *
  * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
  *
- * @static
- * @alias module:Other.loadScript
+ * @alias module:Browser.loadScript
  * @since 4.19.0
  * @param {string} src  js 地址。
  * @param {Object} [options] script 标签属性。比如 `defer` `onload` `onerror` `id` 等，下面列举部分带有默认值或额外扩展的配置。

package/types/minus.d.ts

@@ -1,7 +1,6 @@
 /**
  * 精确减法，支持多个数相减，减数默认为 0 。
  *
- * @static
  * @alias module:Math.minus
  * @since 3.1.0
  * @param {...(number|string)} nums 相减的数

package/types/numberToChinese.d.ts

@@ -14,7 +14,6 @@ type Options = {
  *
  * 如果数字不在安全数字 -9007199254740991～9007199254740991 范围内，处理会有异常。
  *
- * @static
  * @alias module:Processor.numberToChinese
  * @since 1.2.0
  * @see {@link https://openstd.samr.gov.cn/bzgk/gb/newGbInfo?hcno=F5DAC3377DA99C8D78AE66735B6359C7 | 出版物上数字用法}

package/types/padZero.d.ts

@@ -1,7 +1,6 @@
 /**
  * 前置补零
  *
- * @static
  * @alias module:Processor.padZero
  * @since 4.7.0
  * @param {string|number} value 要处理的值

package/types/parseIdCard.d.ts

@@ -33,7 +33,6 @@ type IdCardInfo = {
 /**
  * 解析身份证号码，支持15、18位身份证号码
  *
- * @static
  * @alias module:Processor.parseIdCard
  * @since 4.0.0
  * @see {@link https://baike.baidu.com/item/居民身份证号码 | 居民身份证号码}

package/types/plus.d.ts

@@ -1,7 +1,6 @@
 /**
  * 精确加法，支持多个数相加，加数默认为 0 。
  *
- * @static
  * @alias module:Math.plus
  * @since 3.1.0
  * @param {...(number|string)} nums 相加的数

package/types/replaceChar.d.ts

@@ -8,7 +8,6 @@ type Options = {
 /**
  * 替换字符，应用场景如：脱敏
  *
- * @static
  * @alias module:Processor.replaceChar
  * @since 1.1.0
  * @param {string} str 要处理的字符串

package/types/round.d.ts

@@ -1,7 +1,6 @@
 /**
  * 四舍五入，支持设置精度
  *
- * @static
  * @alias module:Math.round
  * @since 3.1.0
  * @param {number|string} num 要四舍五入的数字

package/types/setDataURLPrefix.d.ts

@@ -3,7 +3,6 @@
  *
  * 如果你需要获取DataURL 的 MIME 类型和数据本身，推荐使用 <a href="https://www.npmjs.com/package/data-urls">data-urls</a>。
  *
- * @static
  * @alias module:Processor.setDataURLPrefix
  * @since 4.1.0
  * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/URI/Schemes/data | Data URLs}

package/types/strlen.d.ts

@@ -1,7 +1,6 @@
 /**
  * 获取字符长度。中文汉字占2个字符，英文占1个字符，特殊如emoji占4个字符。
  *
- * @static
  * @alias module:Other.strlen
  * @since 4.10.0
  * @param {string} str 字符串

package/types/times.d.ts

@@ -1,7 +1,6 @@
 /**
  * 精确乘法，支持多个数相乘，乘数默认为 1 。
  *
- * @static
  * @alias module:Math.times
  * @since 3.1.0
  * @param {...(number|string)} nums 相乘的数

package/types/transformFieldNames.d.ts

@@ -6,7 +6,6 @@ type TransformFieldNames<D extends any, F extends Record<string, any>, C extends
 /**
  * 转换字段名，返回一个转换字段后的值，不改变原值。
  *
- * @static
  * @alias module:Tree.transformFieldNames
  * @since 4.14.0
  * @param {Object[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField

package/types/transformObjectValue.d.ts

@@ -10,7 +10,6 @@ interface TransformObjectValue {
  *
  * 例如 antd Form 中的设置表单值时，如果值为空字符串可能需要转为 `undefined` ，才不影响表单的初始值。
  *
- * @static
  * @alias module:Processor.transformObjectValue
  * @since 4.23.0
  * @param {Array | Object} data 要转换值的普通对象或数组

package/types/treeToList.d.ts

@@ -1,7 +1,6 @@
 /**
  * 树结构转列表数据
  *
- * @static
  * @alias module:Tree.treeToList
  * @since 4.14.0
  * @param {Object[]} tree 树结构数据

package/types/utils/config.d.ts

@@ -3,7 +3,6 @@ declare const config: {
 };
 /**
  * 设置禁止warning提示
- * @static
  * @alias module:Debug.formatBankCard
  * @since 3.6.1
  * @param {boolean} bool 是否禁止warning提示

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

@@ -1,8 +1,11 @@
+export declare function getFileNameExt(name: string): string;
 export declare function testExt(name: string | undefined, ext: string): boolean;
 export type UploadFile = {
-    uid: string;
     name: string;
     type?: string;
     url?: string;
+    fileName?: string;
+    uid?: string;
+    originFileObj?: File;
 };
 export declare function isUploadFile(fileObj: UploadFile): boolean;

package/types/validatePassword.d.ts

@@ -20,7 +20,6 @@ type Options = {
 /**
  * 验证密码（数字、大小写字母、特殊字符、非法字符）
  *
- * @static
  * @alias module:Validator.validatePassword
  * @since 3.7.0
  * @see {@link https://baike.baidu.com/item/ASCII#3 | ASCII}

package/types/BlobUrl.d.ts

@@ -1,41 +0,0 @@
-/**
- * Blob 对象 URL 记录。
- *
- * 便于管理项目中上传文件通过 `URL.createObjectURL` 生成的对象URL。
- *
- * 特点：
- * 1. 避免重复创建，相同的 `Blob` 对象只会生成一个 URL 字符串
- * 2. 当清除缓存时，自动释放内存
- *
- * @class
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/URL/createObjectURL_static | URL：createObjectURL()}
- * @example
- * const blobUrl = new BlobUrl();
- *
- */
-declare class BlobUrl {
-    protected cache: Map<Blob, string>;
-    constructor();
-    /**
-     * 同 `URL.createObjectURL` 方法，创建一个对象 URL 字符串。
-     *
-     * 生成时内部会记录一个缓存，相同的 `Blob` 对象最多只会产生一个 URL 字符串。
-     *
-     * @param {Blob} obj 用于创建 URL 的 File、Blob 对象。
-     * @returns 一个包含对象 URL 的字符串，可用于引用指定源 object 的内容。
-     */
-    createObjectURL(obj: Blob): string | undefined;
-    /**
-     * 同 `URL.revokeObjectURL` 方法，释放对象 URL 。
-     *
-     * @param {string} url 通过调用 `createObjectURL()` 方法创建的对象 URL 的字符串。
-     */
-    revokeObjectURL(url: string): void;
-    /**
-     * 清理缓存。
-     *
-     * 迭代调用 `URL.revokeObjectURL` 来释放内存。
-     */
-    clear(): void;
-}
-export default BlobUrl;