util-helpers 4.16.0 → 4.16.1

package/lib/isSocialCreditCode.js

@@ -50,8 +50,8 @@ function sumCheckCode(preCode) {
  *
  * @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，不校验校验位。

package/lib/isSwiftCode.js

@@ -13,8 +13,8 @@ var reg = /^[A-Z]{6}[A-Z\d]{2}(?:[A-Z\d]{3})?$/;
  *
  * @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

package/lib/isTWCard.js

@@ -18,7 +18,7 @@ var singleRegTWCard = /^[\da-z]{10,12}$/i;
  * @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，表示支持一次性短期通行证

package/lib/isUrl.js

@@ -30,7 +30,7 @@ var regNonProtocal = new RegExp("^(?:".concat(serverReg, ")(?:").concat(portReg,
  * @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

package/lib/isVehicle.js

@@ -14,8 +14,8 @@ var reg = /^[京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕
  *
  * @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

package/lib/normalizeString.js

@@ -12,8 +12,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  *
  * @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

package/lib/parseIdCard.js

@@ -75,7 +75,7 @@ var Provinces = [
  * @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

package/lib/safeDate.js

@@ -38,8 +38,8 @@ function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf ? Objec
  *
  * @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 实例日期对象

package/lib/setDataURLPrefix.js

@@ -10,9 +10,9 @@ exports["default"] = void 0;
  *
  * @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/lib/utils/config.js

@@ -24,5 +24,5 @@ function setDisableWarning(bool) {
 }
 
 // eslint-disable-next-line no-undef
-var version = "4.16.0";
+var version = "4.16.1";
 exports.version = version;

package/lib/validatePassword.js

@@ -136,10 +136,10 @@ function hasUnallowableCharacter(val, chars) {
 /**
  * 验证密码（数字、大小写字母、特殊字符、非法字符）
  *
- * @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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.16.0",
+  "version": "4.16.1",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",

package/types/blobToDataURL.d.ts

@@ -4,11 +4,11 @@ export default blobToDataURL;
  *
  * <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 字符串。

package/types/calculateCursorPosition.d.ts

@@ -5,8 +5,8 @@ export default calculateCursorPosition;
  * @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 当前输入原值

package/types/dataURLToBlob.d.ts

@@ -4,8 +4,8 @@ export default dataURLToBlob;
  *
  * @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

package/types/download.d.ts

@@ -3,8 +3,8 @@ export default download;
  * ajax 配置项
  */
 export type AjaxOptions = import('./ajax.js').AjaxOptions;
-export type TransformRequest = (options: AjaxOptions) => AjaxOptions;
-export type TransformResponse = (res: Blob) => Blob;
+export type TransformRequest = (options: AjaxOptions) => AjaxOptions | Promise<AjaxOptions>;
+export type TransformResponse = (res: Blob) => Blob | Promise<Blob>;
 /**
  * 下载配置项
  */
@@ -36,12 +36,12 @@ export type DownloadOptions = {
 /**
  * @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>}
  */
 /**
  * @typedef {Object} DownloadOptions 下载配置项
@@ -59,7 +59,8 @@ export type DownloadOptions = {
  * @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>}

package/types/isBankCard.d.ts

@@ -4,8 +4,8 @@ export default isBankCard;
  *
  * @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位数字

package/types/isBusinessLicense.d.ts

@@ -4,8 +4,8 @@ export default isBusinessLicense;
  *
  * @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，不校验校验位。

package/types/isChinese.d.ts

@@ -5,9 +5,9 @@ export default isChinese;
  * @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

package/types/isHMCard.d.ts

@@ -5,7 +5,7 @@ export default isHMCard;
  * @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

package/types/isIdCard.d.ts

@@ -5,8 +5,8 @@ export default isIdCard;
  * @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位身份证号码

package/types/isPassport.d.ts

@@ -5,8 +5,8 @@ export default isPassport;
  *
  * @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

package/types/isPassword.d.ts

@@ -4,11 +4,11 @@ export default isPassword;
  * <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-包含三种字符。（大写字母、小写字母、数字、特殊字符）

package/types/isSocialCreditCode.d.ts

@@ -4,8 +4,8 @@ export default isSocialCreditCode;
  *
  * @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，不校验校验位。

package/types/isSwiftCode.d.ts

@@ -4,8 +4,8 @@ export default isSwiftCode;
  *
  * @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

package/types/isTWCard.d.ts

@@ -5,7 +5,7 @@ export default isTWCard;
  * @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，表示支持一次性短期通行证

package/types/isUrl.d.ts

@@ -5,7 +5,7 @@ export default isUrl;
  * @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

package/types/isVehicle.d.ts

@@ -4,8 +4,8 @@ export default isVehicle;
  *
  * @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

package/types/normalizeString.d.ts

@@ -4,8 +4,8 @@ export default normalizeString;
  *
  * @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

package/types/parseIdCard.d.ts

@@ -76,7 +76,7 @@ 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 {IdCardInfo | null} 省份、生日、性别，省/市/区/年/月/日/性别编码。如果解析失败将返回 null 。
  * @example

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/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-包含三种字符。（大写字母、小写字母、数字、特殊字符）