util-helpers 4.15.3 → 4.16.1

package/lib/download.js

@@ -0,0 +1,176 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _dataURLToBlob = _interopRequireDefault(require("./dataURLToBlob"));
+var _isUrl = _interopRequireDefault(require("./isUrl"));
+var _ajax = _interopRequireDefault(require("./ajax"));
+var _type = require("./utils/type");
+var _isPromiseLike = _interopRequireDefault(require("./isPromiseLike"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+/**
+ * 下载文件
+ * 
+ * @param {string} blobUrl blob 地址
+ * @param {string} [fileName] 文件名称
+ */
+function saver(blobUrl, fileName) {
+  var anchor = document.createElement('a');
+  // anchor.href = decodeURIComponent(blobUrl);
+  anchor.href = blobUrl;
+  anchor.style.display = 'none';
+  anchor.setAttribute('download', fileName || '');
+
+  /**
+   * 处理点击事件，防止事件冒泡到 body/html 的点击事件。
+   * 
+   * @param {MouseEvent} e 鼠标事件对象
+   */
+  function handleClick(e) {
+    e.stopPropagation();
+    anchor.removeEventListener('click', handleClick);
+  }
+  anchor.addEventListener('click', handleClick);
+  document.body.appendChild(anchor);
+  anchor.click();
+  document.body.removeChild(anchor);
+}
+
+/**
+ * @typedef {import('./ajax.js').AjaxOptions} AjaxOptions ajax 配置项
+ */
+
+/**
+ * @callback TransformRequest
+ * @param {AjaxOptions} options ajax 配置项
+ * @returns {AjaxOptions | Promise<AjaxOptions>}
+ */
+
+/**
+ * @callback TransformResponse
+ * @param {Blob} res 响应的Blob对象。如果你通过 transformRequest 修改了 responseType ，该参数将是该类型响应值。
+ * @returns {Blob | Promise<Blob>}
+ */
+
+/**
+ * @typedef {Object} DownloadOptions 下载配置项
+ * @property {string} [options.fileName] 文件名称
+ * @property {string} [options.type] MIME 类型
+ * @property {'url'|'text'} [options.dataType] 手动设置数据类型，默认会根据传入的数据判断类型，主要是为了区分 url 和 text 。<br/>如果你要下载的文本是 url ，请设置 'text' ；如果你要下载的 url 是绝对/相对路径，请设置 'url' 。
+ * @property {TransformRequest} [options.transformRequest] 请求前触发，XHR 对象或配置调整
+ * @property {TransformResponse} [options.transformResponse] 请求成功后触发，在传递给 then/catch 前，允许修改响应数据
+ */
+
+/**
+ * 下载<br/><br/>
+ * 
+ * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端，兼容 IE10+ 和现代浏览器。</em>
+ * 
+ * @static
+ * @alias module:Other.download
+ * @since 4.16.0
+ * @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>}
+ * @example
+ * // 文本
+ * download('hello world', 'text.txt');
+ * 
+ * // 远程文件
+ * download('/xxx.jpg', { dataType: 'url' });
+ * 
+ * // blob文件
+ * download(new Blob(['hello world']), 'text.txt');
+ * 
+ */
+function download(data, options) {
+  var config = _typeof(options) === 'object' ? options : {};
+  if (typeof options === 'string') {
+    config.fileName = options;
+  }
+  var fileName = config.fileName,
+    type = config.type,
+    dataType = config.dataType,
+    transformRequest = config.transformRequest,
+    transformResponse = config.transformResponse;
+
+  /** @type {Blob|undefined} */
+  var payload;
+
+  // dataURLs、blob url、url、string
+  if (typeof data === 'string') {
+    if (!dataType && /^blob:.*?\/.*/.test(data)) {
+      // blob url
+      saver(data, fileName);
+      return Promise.resolve();
+    } else if (!dataType && /^data:([\w+-]+\/[\w+.-]+)?[,;]/.test(data)) {
+      // dataURLs
+      payload = (0, _dataURLToBlob["default"])(data);
+    } else if (dataType === 'url' || !dataType && (0, _isUrl["default"])(data)) {
+      // url
+      // 包装为异步方法
+      /** @type {(opts: AjaxOptions)=>Promise<AjaxOptions>} */
+      var asyncTransformRequest = function asyncTransformRequest(opts) {
+        // 请求前配置调整
+        var tempOptions = typeof transformRequest === 'function' ? transformRequest(opts) : opts;
+        // @ts-ignore
+        return (0, _isPromiseLike["default"])(tempOptions) ? tempOptions : Promise.resolve(tempOptions);
+      };
+      /** @type {(res: Blob)=>Promise<Blob>} */
+      var asyncTransformResponse = function asyncTransformResponse(res) {
+        var tempRes = typeof transformResponse === 'function' ? transformResponse(res) : res;
+        // @ts-ignore
+        return (0, _isPromiseLike["default"])(tempRes) ? tempRes : Promise.resolve(tempRes);
+      };
+
+      // 此处如果使用 async/await 语法糖，编译后的umd代码过大
+      return asyncTransformRequest({
+        responseType: 'blob'
+      }).then(function (ajaxOptions) {
+        return (0, _ajax["default"])(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 || ((0, _type.isBlob)(res) ? res.type : undefined)
+            });
+          });
+        });
+      });
+    } else {
+      // string
+      payload = new Blob([data], {
+        type: type || 'text/plain'
+      });
+    }
+  } else if ((0, _type.isBlob)(data)) {
+    // @ts-ignore
+    payload = data;
+  }
+
+  // html、TypedArray
+  if (!(payload instanceof Blob)) {
+    payload = new Blob([data], {
+      type: type
+    });
+  }
+
+  // @ts-ignore
+  if (navigator.msSaveBlob) {
+    // @ts-ignore
+    navigator.msSaveBlob(payload, fileName || 'download');
+  } else {
+    var url = URL.createObjectURL(payload);
+    saver(url, fileName);
+    URL.revokeObjectURL(url);
+  }
+  return Promise.resolve();
+}
+var _default = download;
+exports["default"] = _default;

package/lib/fileReader.js

@@ -0,0 +1,74 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var FileReaderMethodMap = {
+  arrayBuffer: 'readAsArrayBuffer',
+  binaryString: 'readAsBinaryString',
+  dataURL: 'readAsDataURL',
+  text: 'readAsText'
+};
+
+/**
+ * @overload
+ * @param {Blob} blob
+ * @param {'arrayBuffer'} type
+ * @returns {Promise<ArrayBuffer>}
+ */
+
+/**
+ * @overload
+ * @param {Blob} blob
+ * @param {'binaryString'|'binaryString'|'dataURL'|'text'} [type='dataURL']
+ * @returns {Promise<string>}
+ */
+
+/**
+ * 读取 Blob 或 File 对象，可以将 Blob 转为 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}
+ * @since 4.16.0
+ * @param {Blob} blob Blob 或 File 对象
+ * @param {'arrayBuffer'|'binaryString'|'dataURL'|'text'} [type='dataURL'] Blob 或 File 对象
+ * @returns {Promise<string|ArrayBuffer>} 文件的内容
+ * @example
+ * const aFileParts = ['<a id="a"><b id="b">hey!</b></a>']; // 一个包含DOMString的数组
+ * const htmlBlob = new Blob(aFileParts, { type: 'text/html' }); // 得到 blob
+ *
+ * fileReader(htmlBlob).then(data=>{
+ *   console.log(data); // data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * });
+ *
+ * const textBlob = new Blob(aFileParts, { type: 'text/plain' });
+ *
+ * fileReader(textBlob, 'text').then(data=>{
+ *   console.log(data); // <a id="a"><b id="b">hey!</b></a>
+ * });
+ */
+function fileReader(blob) {
+  var type = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'dataURL';
+  var method = FileReaderMethodMap[type];
+  if (!method) {
+    method = FileReaderMethodMap.dataURL;
+  }
+  return new Promise(function (resolve, reject) {
+    var reader = new FileReader();
+    // @ts-ignore
+    reader[method](blob);
+    // @ts-ignore
+    reader.onload = function () {
+      return resolve(reader.result);
+    };
+    reader.onerror = function (error) {
+      return reject(error);
+    };
+  });
+}
+var _default = fileReader;
+exports["default"] = _default;

package/lib/index.js

@@ -3,6 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "ajax", {
+  enumerable: true,
+  get: function get() {
+    return _ajax["default"];
+  }
+});
 Object.defineProperty(exports, "blobToDataURL", {
   enumerable: true,
   get: function get() {
@@ -33,6 +39,18 @@ Object.defineProperty(exports, "divide", {
     return _divide["default"];
   }
 });
+Object.defineProperty(exports, "download", {
+  enumerable: true,
+  get: function get() {
+    return _download["default"];
+  }
+});
+Object.defineProperty(exports, "fileReader", {
+  enumerable: true,
+  get: function get() {
+    return _fileReader["default"];
+  }
+});
 Object.defineProperty(exports, "filterTree", {
   enumerable: true,
   get: function get() {
@@ -350,6 +368,7 @@ var _numberToChinese = _interopRequireDefault(require("./numberToChinese"));
 var _bytesToSize = _interopRequireDefault(require("./bytesToSize"));
 var _parseIdCard = _interopRequireDefault(require("./parseIdCard"));
 var _blobToDataURL = _interopRequireDefault(require("./blobToDataURL"));
+var _fileReader = _interopRequireDefault(require("./fileReader"));
 var _dataURLToBlob = _interopRequireDefault(require("./dataURLToBlob"));
 var _setDataURLPrefix = _interopRequireDefault(require("./setDataURLPrefix"));
 var _normalizeString = _interopRequireDefault(require("./normalizeString"));
@@ -361,10 +380,12 @@ var _minus = _interopRequireDefault(require("./minus"));
 var _times = _interopRequireDefault(require("./times"));
 var _divide = _interopRequireDefault(require("./divide"));
 var _round = _interopRequireDefault(require("./round"));
-var _waitTime = _interopRequireDefault(require("./waitTime"));
+var _ajax = _interopRequireDefault(require("./ajax"));
 var _calculateCursorPosition = _interopRequireDefault(require("./calculateCursorPosition"));
+var _download = _interopRequireDefault(require("./download"));
 var _randomString = _interopRequireDefault(require("./randomString"));
 var _strlen = _interopRequireDefault(require("./strlen"));
+var _waitTime = _interopRequireDefault(require("./waitTime"));
 var _transformFieldNames = _interopRequireDefault(require("./transformFieldNames"));
 var _listToTree = _interopRequireDefault(require("./listToTree"));
 var _treeToList = _interopRequireDefault(require("./treeToList"));

package/lib/interface.doc.js

@@ -0,0 +1,127 @@
+"use strict";
+
+/* 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) {}
+
+/**
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest|XMLHttpRequest}
+ * @typedef {Object} AjaxOptions ajax配置项
+ * @property {string} [method="get"] 创建请求时使用的方法
+ * @property {*} [data=null] 请求体被发送的数据
+ * @property {object} [headers] 自定义请求头
+ * @property {string} [responseType] 响应类型
+ * @property {number} [timeout] 请求超时的毫秒数
+ * @property {boolean} [withCredentials=false] 跨域请求时是否需要使用凭证
+ * @property {boolean} [async=true] 是否异步执行操作
+ * @property {string|null} [user=null] 用户名，用于认证用途
+ * @property {string|null} [password=null] 密码，用于认证用途
+ * @property {function} [onLoadStart] 接收到响应数据时触发
+ * @property {function} [onProgress] 请求接收到更多数据时，周期性地触发
+ * @property {function} [onAbort] 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时
+ * @property {function} [onTimeout] 在预设时间内没有接收到响应时触发
+ * @property {function} [onError] 当 request 遭遇错误时触发
+ * @property {function} [onLoad] 请求成功完成时触发
+ * @property {function} [onLoadEnd] 请求结束时触发，无论请求成功 (load) 还是失败 (abort 或 error)
+ */
+
+/**
+ * 请求<br/><br/>
+ * 
+ * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
+ * 
+ * @static
+ * @alias module:Other.ajax
+ * @since 4.16.0
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest|XMLHttpRequest}
+ * @param {string} url 地址
+ * @param {AjaxOptions} [options] 配置项
+ * @returns {Promise<object>} XHR 事件对象
+ * @example
+ * ajax('/somefile').then(res=>{
+ *   // do something
+ * });
+ * 
+ * ajax('/api', { method: 'post' }).then(res=>{
+ *   // do something
+ * });
+ */
+function ajax(url, options) {}
+
+/**
+ * @callback TransformRequest
+ * @param {AjaxOptions} options ajax 配置项
+ * @returns {AjaxOptions | Promise<AjaxOptions>}
+ */
+
+/**
+ * @callback TransformResponse
+ * @param {Blob} res 响应的Blob对象。如果你通过 transformRequest 修改了 responseType ，该参数将是该类型响应值。
+ * @returns {Blob | Promise<Blob>}
+ */
+
+/**
+ * @typedef {Object} DownloadOptions 下载配置项
+ * @property {string} [options.fileName] 文件名称
+ * @property {string} [options.type] MIME 类型
+ * @property {'url'|'text'} [options.dataType] 手动设置数据类型，默认会根据传入的数据判断类型，主要是为了区分 url 和 text 。<br/>如果你要下载的文本是 url ，请设置 'text' ；如果你要下载的 url 是绝对/相对路径，请设置 'url' 。
+ * @property {TransformRequest} [options.transformRequest] 请求前触发，XHR 对象或配置调整
+ * @property {TransformResponse} [options.transformResponse] 请求成功后触发，在传递给 then/catch 前，允许修改响应数据
+ */
+
+/**
+ * 下载<br/><br/>
+ * 
+ * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端，兼容 IE10+ 和现代浏览器。</em>
+ * 
+ * @static
+ * @alias module:Other.download
+ * @since 4.16.0
+ * @see {@link https://zh.wikipedia.org/wiki/多用途互聯網郵件擴展|MIME}
+ * @see {@link https://9ykc9s.csb.app/|在线示例}
+ * @param {string|Blob|TypedArray} data 字符串、blob数据或url地址
+ * @param {string|DownloadOptions} [options] 文件名称 或 配置项
+ * @returns {Promise<void>}
+ * @example
+ * // 文本
+ * download('hello world', 'text.txt');
+ * 
+ * // 远程文件
+ * download('/xxx.jpg', { dataType: 'url' });
+ * 
+ * // blob文件
+ * download(new Blob(['hello world']), 'text.txt');
+ * 
+ */
+function download(data, fileName, options) {}

package/lib/isBankCard.js

@@ -34,8 +34,8 @@ function sumCheckCode(numStr) {
  *
  * @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/lib/isBusinessLicense.js

@@ -44,8 +44,8 @@ function sumCheckCode(preCode) {
  *
  * @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/lib/isChinese.js

@@ -39,9 +39,9 @@ var supportRegExpUnicode = RegExp.prototype.hasOwnProperty('unicode');
  * @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/lib/isHMCard.js

@@ -15,7 +15,7 @@ var regHMCard = /^[hm]{1}([0-9]{10}|[0-9]{8})$/i;
  * @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/lib/isIdCard.js

@@ -35,8 +35,8 @@ function check(id) {
  * @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/lib/isPassport.js

@@ -15,8 +15,8 @@ var reg = /^((e[\da-z])|(de)|(se)|(pe)|([khm][\da-z]))[\da-z]{7}$/i;
  *
  * @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/lib/isPassword.js

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

@@ -136,8 +136,9 @@ function mapNumberChar(num) {
 }
 
 /**
- * 数字转中文数字
- * 不在安全数字 -9007199254740991～9007199254740991 内，处理会有异常
+ * 数字转中文数字<br/><br/>
+ * 
+ * 如果数字不在安全数字 -9007199254740991～9007199254740991 范围内，处理会有异常。
  *
  * @static
  * @alias module:Processor.numberToChinese

package/lib/parseIdCard.js

@@ -75,9 +75,9 @@ 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 {null|IdCardInfo} null 或 省份、生日、性别，省/市/区/年/月/日/性别编码
+ * @returns {IdCardInfo | null} 省份、生日、性别，省/市/区/年/月/日/性别编码。如果解析失败将返回 null 。
  * @example
  * 
  * parseIdCard('123456789123456'); // null