util-helpers 4.16.0 → 4.16.2

package/README.md

@@ -50,9 +50,9 @@ formatBankCard('6228480402564890018', { spaceMark: '-' }); // 6228-4804-0256-489
   - [divide](https://doly-dev.github.io/util-helpers/module-Math.html#.divide) - 除
   - [round](https://doly-dev.github.io/util-helpers/module-Math.html#.round) - 四舍五入
 - 数据处理
-  - [blobToDataURL](https://doly-dev.github.io/util-helpers/module-Processor.html#.blobToDataURL) - 将 Blob 或 File 对象转成 data:URL 格式的 Base64 字符串
   - [bytesToSize](https://doly-dev.github.io/util-helpers/module-Processor.html#.bytesToSize) - 字节转换为存储单位
   - [dataURLToBlob](https://doly-dev.github.io/util-helpers/module-Processor.html#.dataURLToBlob) - 将 DataURL 转为 Blob 对象
+  - [fileReader](https://doly-dev.github.io/util-helpers/module-Processor.html#.fileReader) - 读取 Blob 或 File 对象，转为 Base64/String/ArrayBuffer
   - [formatMoney](https://doly-dev.github.io/util-helpers/module-Processor.html#.formatMoney) - 格式化金额
   - [formatMobile](https://doly-dev.github.io/util-helpers/module-Processor.html#.formatMobile) - 格式化手机号码
   - [formatBankCard](https://doly-dev.github.io/util-helpers/module-Processor.html#.formatBankCard) - 格式化银行卡
@@ -95,7 +95,9 @@ formatBankCard('6228480402564890018', { spaceMark: '-' }); // 6228-4804-0256-489
   - [isBusinessLicense](https://doly-dev.github.io/util-helpers/module-Validator.html#.isBusinessLicense) - 营业执照，也叫工商注册号
   - [validatePassword](https://doly-dev.github.io/util-helpers/module-Validator.html#.validatePassword) - 验证密码
 - 其他
+  - [ajax](https://doly-dev.github.io/util-helpers/module-Other.html#.ajax) - 请求
   - [calculateCursorPosition](https://doly-dev.github.io/util-helpers/module-Other.html#.calculateCursorPosition) - 计算光标位置
+  - [download](https://doly-dev.github.io/util-helpers/module-Other.html#.download) - 下载
   - [randomString](https://doly-dev.github.io/util-helpers/module-Other.html#.randomString) - 随机字符串
   - [strlen](https://doly-dev.github.io/util-helpers/module-Other.html#.strlen) - 字符长度
   - [waitTime](https://doly-dev.github.io/util-helpers/module-Other.html#.waitTime) - 等待时间返回 Promise

package/dist/util-helpers.js

@@ -110,8 +110,8 @@
    *
    * @static
    * @alias module:Processor.normalizeString
-   * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances|String}
    * @since 4.3.0
+   * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances|String}
    * @param {*} value 待处理的值
    * @returns {string} 规整化的值
    * @example
@@ -235,8 +235,8 @@
    * @static
    * @alias module:Validator.isIdCard
    * @since 1.1.0
-   * @see 参考 {@link https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码|中华人民共和国公民身份号码}
-   * @see 参考 {@link https://baike.baidu.com/item/居民身份证号码|居民身份证号码}
+   * @see {@link https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码|中华人民共和国公民身份号码}
+   * @see {@link https://baike.baidu.com/item/居民身份证号码|居民身份证号码}
    * @param {*} value 要检测的值
    * @param {Object} [options] 配置项
    * @param {boolean} [options.loose=false] 宽松模式，支持15位身份证号码
@@ -350,8 +350,8 @@
    *
    * @static
    * @alias module:Validator.isVehicle
-   * @see 参考 {@link https://baike.baidu.com/item/车牌号|车牌号}
    * @since 1.1.0
+   * @see {@link https://baike.baidu.com/item/车牌号|车牌号}
    * @param {*} value 要检测的值
    * @returns {boolean} 值是否为车牌号
    * @example
@@ -400,8 +400,8 @@
    *
    * @static
    * @alias module:Validator.isBankCard
-   * @see 参考 {@link https://kf.qq.com/faq/170112ABnm6b170112FvquAn.html|常用银行账号位数参考}
    * @since 1.1.0
+   * @see {@link https://kf.qq.com/faq/170112ABnm6b170112FvquAn.html|常用银行账号位数参考}
    * @param {*} value 要检测的值
    * @param {Object} [options] 配置项
    * @param {boolean} [options.loose=false] 宽松模式，8~30位数字
@@ -477,8 +477,8 @@
    *
    * @static
    * @alias module:Validator.isSocialCreditCode
-   * @see 参考 {@link https://zh.wikisource.org/zh-hans/GB_32100-2015_法人和其他组织统一社会信用代码编码规则|GB 32100-2015 法人和其他组织统一社会信用代码编码规则}
    * @since 1.1.0
+   * @see {@link https://zh.wikisource.org/zh-hans/GB_32100-2015_法人和其他组织统一社会信用代码编码规则|GB 32100-2015 法人和其他组织统一社会信用代码编码规则}
    * @param {*} value 要检测的值
    * @param {Object} [options] 配置项
    * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，如果为false，不校验校验位。
@@ -537,7 +537,7 @@
   }
 
   // eslint-disable-next-line no-undef
-  var version = "4.16.0";
+  var version = "4.16.2";
 
   /**
    * 打印警告信息
@@ -681,10 +681,10 @@
   /**
    * 验证密码（数字、大小写字母、特殊字符、非法字符）
    *
-   * @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-包含三种字符。（大写字母、小写字母、数字、特殊字符）
@@ -817,11 +817,11 @@
    * <p><strong>注意：该校验只校验是否存在不同字符(大小写字母、数字、特殊符号)，不判断长度。</strong></p>
    * <p><i>如果需要更细致的验证，请使用 <a href="#.validatePassword">validatePassword</a></i></p>
    *
-   * @see 参考 {@link https://baike.baidu.com/item/ASCII#3|ASCII}
    * @static
    * @alias module:Validator.isPassword
-   * @since 1.1.0
    * @requires module:Validator.validatePassword
+   * @since 1.1.0
+   * @see {@link https://baike.baidu.com/item/ASCII#3|ASCII}
    * @param {*} value 要检测的值
    * @param {Object} [options] 配置项
    * @param {number} [options.level=2] 密码强度 1-包含一种字符 2-包含两种字符 3-包含三种字符。（大写字母、小写字母、数字、特殊字符）
@@ -869,8 +869,8 @@
    *
    * @static
    * @alias module:Validator.isPassport
-   * @see 参考 {@link https://zh.wikipedia.org/wiki/中华人民共和国护照#个人资料页|中华人民共和国护照#个人资料页}
    * @since 1.1.0
+   * @see {@link https://zh.wikipedia.org/wiki/中华人民共和国护照#个人资料页|中华人民共和国护照#个人资料页}
    * @param {*} value 要检测的值
    * @returns {boolean} 值是否为护照号
    * @example
@@ -917,9 +917,9 @@
    * @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}
-   * @see 参考 {@link https://zh.wikipedia.org/wiki/Unicode字符平面映射|Unicode字符平面映射}
-   * @see 参考 {@link https://zh.wikipedia.org/wiki/Unicode區段|Unicode区段}
+   * @see {@link http://www.unicode.org/reports/tr38/#BlockListing|4.4 Listing of Characters Covered by the Unihan Database}
+   * @see {@link https://zh.wikipedia.org/wiki/Unicode字符平面映射|Unicode字符平面映射}
+   * @see {@link https://zh.wikipedia.org/wiki/Unicode區段|Unicode区段}
    * @param {*} value 要检测的值
    * @param {Object} [options] 配置项
    * @param {boolean} [options.loose=false] 宽松模式。如果为true，只要包含中文即为true
@@ -1044,7 +1044,7 @@
    * @static
    * @alias module:Validator.isUrl
    * @since 3.4.0
-   * @see 参考 {@link https://zh.wikipedia.org/wiki/统一资源定位符|统一资源定位符}
+   * @see {@link https://zh.wikipedia.org/wiki/统一资源定位符|统一资源定位符}
    * @param {*} value 要检测的值
    * @returns {boolean} 值是否为url
    * @example
@@ -1112,8 +1112,8 @@
    *
    * @static
    * @alias module:Validator.isBusinessLicense
-   * @see 参考 {@link https://wenku.baidu.com/view/19873704cc1755270722087c.html|GS15—2006 工商行政管理市场主体注册号编制规则}
    * @since 3.5.0
+   * @see {@link https://wenku.baidu.com/view/19873704cc1755270722087c.html|GS15—2006 工商行政管理市场主体注册号编制规则}
    * @param {*} value 要检测的值
    * @param {Object} [options] 配置项
    * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，如果为false，不校验校验位。
@@ -1450,7 +1450,7 @@
    * @static
    * @alias module:Validator.isHMCard
    * @since 4.0.0
-   * @see 参考 {@link https://zh.wikipedia.org/wiki/港澳居民来往内地通行证|港澳居民来往内地通行证}
+   * @see {@link https://zh.wikipedia.org/wiki/港澳居民来往内地通行证|港澳居民来往内地通行证}
    * @param {*} value 要检测的值
    * @returns {boolean} 是否为港澳居民来往内地通行证
    * @example
@@ -1483,7 +1483,7 @@
    * @static
    * @alias module:Validator.isTWCard
    * @since 4.0.0
-   * @see 参考 {@link https://zh.wikipedia.org/wiki/台湾居民来往大陆通行证|台湾居民来往大陆通行证}
+   * @see {@link https://zh.wikipedia.org/wiki/台湾居民来往大陆通行证|台湾居民来往大陆通行证}
    * @param {*} value 要检测的值
    * @param {Object} [options] 配置项
    * @param {boolean} [options.loose=false] 宽松模式。如果为true，表示支持一次性短期通行证
@@ -1517,8 +1517,8 @@
    *
    * @static
    * @alias module:Validator.isSwiftCode
-   * @see 参考 {@link https://zh.wikipedia.org/wiki/ISO_9362|ISO 9362}
    * @since 4.9.0
+   * @see {@link https://zh.wikipedia.org/wiki/ISO_9362|ISO 9362}
    * @param {*} value 要检测的值
    * @returns {boolean} 值是否为 Swift Code
    * @example
@@ -2447,7 +2447,7 @@
    * @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 {IdCardInfo | null} 省份、生日、性别，省/市/区/年/月/日/性别编码。如果解析失败将返回 null 。
    * @example
@@ -2533,13 +2533,13 @@
    */
 
   /**
-   * 读取 Blob 或 File 对象<br/><br/>
+   * 读取 Blob 或 File 对象，转为 Base64/String/ArrayBuffer<br/><br/>
    * 
    * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
    *
    * @static
    * @alias module:Processor.fileReader
-   * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader|FileReader}
+   * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader|FileReader}
    * @since 4.16.0
    * @param {Blob} blob Blob 或 File 对象
    * @param {'arrayBuffer'|'binaryString'|'dataURL'|'text'} [type='dataURL'] Blob 或 File 对象
@@ -2585,11 +2585,11 @@
    * 
    * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
    *
+   * @ignore
    * @static
    * @alias module:Processor.blobToDataURL
-   * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader/readAsDataURL|FileReader.readAsDataURL()}
    * @since 4.1.0
-   * @ignore
+   * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader/readAsDataURL|FileReader.readAsDataURL()}
    * @deprecated 请使用 `fileReader` 方法
    * @param {Blob} blob Blob 或 File 对象
    * @returns {Promise<string>} data:URL 格式的 Base64 字符串。
@@ -2616,8 +2616,8 @@
    *
    * @static
    * @alias module:Processor.dataURLToBlob
-   * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Glossary/Base64|Base64}
    * @since 4.1.0
+   * @see {@link https://developer.mozilla.org/zh-CN/docs/Glossary/Base64|Base64}
    * @param {string} dataurl data: 协议的URL
    * @returns {Blob} Blob 对象
    * @example
@@ -2646,9 +2646,9 @@
    *
    * @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 标识
@@ -2701,8 +2701,8 @@
    *
    * @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
+   * @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 实例日期对象
@@ -3156,8 +3156,8 @@
    * @static
    * @alias module:Other.calculateCursorPosition
    * @since 4.6.0
-   * @see h5示例 {@link https://2950v9.csb.app/|点击查看}
-   * @see react示例 {@link https://33ccy9.csb.app/|点击查看}
+   * @see {@link https://2950v9.csb.app/|h5示例}
+   * @see {@link https://33ccy9.csb.app/|react示例}
    * @param {number} prevPos 赋值前的光标位置，onChange/onInput的光标位置 e.target.selectionEnd
    * @param {string} prevCtrlValue 上一个格式化后的值
    * @param {string} rawValue 当前输入原值
@@ -3236,13 +3236,13 @@
   /**
    * @callback TransformRequest
    * @param {AjaxOptions} options ajax 配置项
-   * @returns {AjaxOptions}
+   * @returns {AjaxOptions | Promise<AjaxOptions>}
    */
 
   /**
    * @callback TransformResponse
    * @param {Blob} res 响应的Blob对象。如果你通过 transformRequest 修改了 responseType ，该参数将是该类型响应值。
-   * @returns {Blob}
+   * @returns {Blob | Promise<Blob>}
    */
 
   /**
@@ -3262,7 +3262,8 @@
    * @static
    * @alias module:Other.download
    * @since 4.16.0
-   * @see {@link https://zh.wikipedia.org/wiki/多用途互聯網郵件擴展|多用途互联网邮件扩展}
+   * @see {@link https://zh.wikipedia.org/wiki/多用途互聯網郵件擴展|MIME}
+   * @see {@link https://9ykc9s.csb.app/|在线示例}
    * @param {string|Blob|ArrayBuffer|Int8Array|Uint8Array|Uint8ClampedArray|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array|BigInt64Array|BigUint64Array} data 字符串、blob数据或url地址
    * @param {string|DownloadOptions} [options] 文件名称 或 配置项
    * @returns {Promise<void>}
@@ -3302,21 +3303,34 @@
         payload = dataURLToBlob(data);
       } else if (dataType === 'url' || !dataType && isUrl(data)) {
         // url
-        /** @type {AjaxOptions} */
-        var defaultAjaxOptions = {
-          responseType: 'blob'
+        // 包装为异步方法
+        /** @type {(opts: AjaxOptions)=>Promise<AjaxOptions>} */
+        var asyncTransformRequest = function asyncTransformRequest(opts) {
+          // 请求前配置调整
+          var tempOptions = typeof transformRequest === 'function' ? transformRequest(opts) : opts;
+          // @ts-ignore
+          return isPromiseLike(tempOptions) ? tempOptions : Promise.resolve(tempOptions);
         };
-        // 请求前配置调整
-        var ajaxOptions = typeof transformRequest === 'function' ? transformRequest(defaultAjaxOptions) : defaultAjaxOptions;
-        return ajax(data, ajaxOptions).then(function (e) {
-          /** @type {Blob} */
+        /** @type {(res: Blob)=>Promise<Blob>} */
+        var asyncTransformResponse = function asyncTransformResponse(res) {
+          var tempRes = typeof transformResponse === 'function' ? transformResponse(res) : res;
           // @ts-ignore
-          // 响应结果调整
-          var res = typeof transformResponse === 'function' ? transformResponse(e.target.response) : e.target.response;
-          var currentFileName = fileName || data.split("?")[0].split("#")[0].split("/").pop();
-          return download(res, {
-            fileName: currentFileName,
-            type: type || (isBlob(res) ? res.type : undefined)
+          return isPromiseLike(tempRes) ? tempRes : Promise.resolve(tempRes);
+        };
+
+        // 此处如果使用 async/await 语法糖，编译后的umd代码过大
+        return asyncTransformRequest({
+          responseType: 'blob'
+        }).then(function (ajaxOptions) {
+          return ajax(data, ajaxOptions).then(function (e) {
+            // @ts-ignore
+            return asyncTransformResponse(e.target.response).then(function (res) {
+              var currentFileName = fileName || data.split("?")[0].split("#")[0].split("/").pop();
+              return download(res, {
+                fileName: currentFileName,
+                type: type || (isBlob(res) ? res.type : undefined)
+              });
+            });
           });
         });
       } else {