util-helpers 4.12.6 → 4.12.7

package/lib/isIPv6.js

@@ -22,41 +22,23 @@ var reg = /^((([0-9A-F]{1,4}:){7}([0-9A-F]{1,4}|:))|(([0-9A-F]{1,4}:){6}(:[0-9A-
  * @example
  *
  * // 冒分十六进制表示法
- * isIPv6('2001:0DB8:0000:0023:0008:0800:200C:417A');
- * // => true
+ * isIPv6('2001:0DB8:0000:0023:0008:0800:200C:417A'); // true
  *
  * // 前导0省略
- * isIPv6('2001:DB8:0:23:8:800:200C:417A');
- * // => true
- *
- * isIPv6('FF01:0:0:0:0:0:0:1101');
- * // => true
+ * isIPv6('2001:DB8:0:23:8:800:200C:417A'); // true
+ * isIPv6('FF01:0:0:0:0:0:0:1101'); // true
  *
  * // 0位压缩表示法
- * isIPv6('FF01::1101');
- * // => true
- *
- * isIPv6('::1');
- * // => true
- *
- * isIPv6('::');
- * // => true
- *
- * isIPv6('0:0:0:0:0:0:0:1');
- * // => true
- *
- * isIPv6('0:0:0:0:0:0:0:0');
- * // => true
+ * isIPv6('FF01::1101'); // true
+ * isIPv6('::1'); // true
+ * isIPv6('::'); // true
+ * isIPv6('0:0:0:0:0:0:0:1'); // true
+ * isIPv6('0:0:0:0:0:0:0:0'); // true
  *
  * // 内嵌IPv4地址表示法
- * isIPv6('::192.168.1.1');
- * // => true
- *
- * isIPv6('::FFFF:192.168.1.1');
- * // => true
- *
- * isIPv6('192.168.1.1');
- * // => false
+ * isIPv6('::192.168.1.1'); // true
+ * isIPv6('::FFFF:192.168.1.1'); // true
+ * isIPv6('192.168.1.1'); // false
  *
  */
 

package/lib/isIdCard.js

@@ -49,20 +49,17 @@ function check(id) {
  * @returns {boolean} 值是否为身份证号
  * @example
  *
- * isIdCard('130701199310302288');
- * // => true
+ * isIdCard('130701199310302288'); // true
+ * isIdCard('13070119931030228X'); // false
  *
- * isIdCard('13070119931030228X');
- * // => false
+ * // 不校验校验码
+ * isIdCard('13070119931030228X', { checkCode: false }); // true
  *
- * isIdCard('13070119931030228X', { checkCode: false }); // 不校验校验码
- * // => true
- *
- * isIdCard('320311770706001');
- * // => false
- *
- * isIdCard('320311770706001', { loose: true });
- * // => true
+ * // 默认不支持15位身份证号码
+ * isIdCard('320311770706001'); // false
+ * 
+ * // 宽松模式，支持15位身份证号
+ * isIdCard('320311770706001', { loose: true }); // true
  *
  */
 

package/lib/isMobile.js

@@ -21,11 +21,8 @@ var reg = /^1[3456789]\d{9}$/;
  * @returns {boolean} 值是否为手机号码
  * @example
  *
- * isMobile('13000000000');
- * // => true
- *
- * isMobile('13000');
- * // => false
+ * isMobile('13000000000'); // true
+ * isMobile('13000'); // false
  *
  */
 

package/lib/isPassport.js

@@ -23,11 +23,8 @@ var reg = /^((e[\da-z])|(de)|(se)|(pe)|([khm][\da-z]))[\da-z]{7}$/i;
  * @returns {boolean} 值是否为护照号
  * @example
  *
- * isPassport('E12345678');
- * // => true
- *
- * isPassport('abc');
- * // => false
+ * isPassport('E12345678'); // true
+ * isPassport('abc'); // false
  *
  */
 

package/lib/isPassword.js

@@ -27,27 +27,20 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  * @returns {boolean} 值是否符合密码强度
  * @example
  *
- * isPassword('a12345678');
- * // => true
- *
- * isPassword('a12345678', {level: 3});
- * // => false
- *
- * isPassword('Aa12345678', {level: 3});
- * // => true
- *
- * isPassword('Aa12345678', {level: 3, ignoreCase: true});
- * // => false
- *
- * isPassword('_Aa12345678', {level: 3, ignoreCase: true});
- * // => true
- *
- * // 仅支持 数字、字母、特殊字符，其他字符如中文字符是校验不通过的
- * isPassword('_Aa一二三45678', {level: 3, ignoreCase: true});
- * // => false
- *
- * isPassword(' _Aa12345678', {level: 3, ignoreCase: true});
- * // => false
+ * isPassword('a12345678'); // true
+ * 
+ * // 3级密码强度
+ * isPassword('a12345678', {level: 3}); // false
+ * isPassword('Aa12345678', {level: 3}); // true
+ * 
+ * // 3级密码强度，大小写字符仅计算1级强度
+ * isPassword('Aa12345678', {level: 3, ignoreCase: true}); // false
+ * isPassword('_Aa12345678', {level: 3, ignoreCase: true}); // true
+ *
+ * // 仅支持 数字、字母、特殊字符，其他非法字符如中文字符是校验不通过的
+ * isPassword('_Aa一二三45678', {level: 3, ignoreCase: true}); // false
+ * isPassword(' _Aa12345678', {level: 3, ignoreCase: true}); // false
+ * 
  */
 function isPassword(value) {
   var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},

package/lib/isPostcode.js

@@ -21,11 +21,8 @@ var reg = /^\d{6}$/;
  * @returns {boolean} 值是否为邮政编码
  * @example
  *
- * isPostcode('101111');
- * // => true
- *
- * isPostcode('123');
- * // => false
+ * isPostcode('101111'); // true
+ * isPostcode('123'); // false
  *
  */
 

package/lib/isPromiseLike.js

@@ -17,14 +17,10 @@ function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "functi
  * @returns {boolean} 是否类似Promise对象
  * @example
  *
- * isPromiseLike([]);
- * => false
- *
- * isPromiseLike({then:()=>{}});
- * => true
- *
- * isPromiseLike(Promise.resolve());
- * => true
+ * isPromiseLike([]); // false
+ * isPromiseLike({ then: () => { } }); // true
+ * isPromiseLike(Promise.resolve()); // true
+ * 
  */
 function isPromiseLike(obj) {
   return obj !== null && (_typeof(obj) === 'object' || typeof obj === 'function') && typeof obj.then === 'function';

package/lib/isQQ.js

@@ -21,11 +21,8 @@ var reg = /^[1-9]\d{4,10}$/;
  * @returns {boolean} 值是否为QQ号
  * @example
  *
- * isQQ('12345');
- * // => true
- *
- * isQQ('123');
- * // => false
+ * isQQ('12345'); // true
+ * isQQ('123'); // false
  *
  */
 

package/lib/isSocialCreditCode.js

@@ -59,18 +59,13 @@ function sumCheckCode(preCode) {
  * @returns {boolean} 值是否为统一社会信用代码
  * @example
  *
- * isSocialCreditCode('91350100M000100Y43');
- * // => true
+ * isSocialCreditCode('91350100M000100Y43'); // true
+ * isSocialCreditCode('91350100M000100Y4A'); // false
  *
- * isSocialCreditCode('91350100M000100Y4A');
- * // => false
- *
- * // 不校验校验位
- * isSocialCreditCode('91350100M000100Y4A', { checkCode: false });
- * // => true
- *
- * isSocialCreditCode('91350100M000100Y', { checkCode: false });
- * // => false
+ * // 不校验校验位，长度和类型还是有校验的
+ * isSocialCreditCode('91350100M000100Y4A', { checkCode: false }); // true
+ * isSocialCreditCode('91350100M000100YIO', { checkCode: false }); // false
+ * isSocialCreditCode('91350100M000100Y', { checkCode: false }); // false
  *
  */
 

package/lib/isSwiftCode.js

@@ -21,13 +21,13 @@ var reg = /^[A-Z]{6}[A-Z\d]{2}(?:[A-Z\d]{3})?$/;
  * @returns {boolean} 值是否为 Swift Code
  * @example
  *
- * isSwiftCode('DEUTDEFF') //  true
- * isSwiftCode('deutdeff') //  false
+ * isSwiftCode('DEUTDEFF'); // true
+ * isSwiftCode('deutdeff'); // false
  *
- * isSwiftCode('BKTWTWTP010') //  true
- * isSwiftCode('010BKTWTWTP') //  false
+ * isSwiftCode('BKTWTWTP010'); // true
+ * isSwiftCode('010BKTWTWTP'); // false
  *
- * isSwiftCode('ICBKCNBJBJM') //  true
+ * isSwiftCode('ICBKCNBJBJM'); // true
  *
  */
 

package/lib/isTWCard.js

@@ -25,12 +25,15 @@ var singleRegTWCard = /^[\da-z]{10,12}$/i;
  * @param {boolean} [options.loose=false] 宽松模式。如果为true，表示支持一次性短期通行证
  * @returns {boolean} 是否为台湾居民来往大陆通行证
  * @example
- * isTWCard('12345678') // true
- * isTWCard('07257456') // true
+ * 
+ * isTWCard('12345678'); // true
+ * isTWCard('07257456'); // true
  *
  * // 一次性短期
- * isTWCard('F290299977') // false
- * isTWCard('F290299977', { loose: true }) // true
+ * isTWCard('F290299977'); // false
+ * 
+ * // 宽松模式，支持一次性短期通行证
+ * isTWCard('F290299977', { loose: true }); // true
  */
 
 function isTWCard(value) {

package/lib/isTelephone.js

@@ -21,17 +21,14 @@ var reg = /^(0\d{2,3}\-)?([2-9]\d{6,7})(\-\d{1,6})?$/;
  * @returns {boolean} 值是否为固定电话
  * @example
  *
- * isTelephone('22033212');
- * // => true
+ * isTelephone('22033212'); // true
+ * isTelephone('13000000000'); // false
+ * 
+ * // 含区号
+ * isTelephone('021-22033212'); // true
  *
- * isTelephone('021-22033212');
- * // => true
- *
- * isTelephone('021-22033212-123');
- * // => true
- *
- * isTelephone('13000000000');
- * // => false
+ * // 含区号和分机号
+ * isTelephone('021-22033212-123'); // true
  *
  */
 

package/lib/isUrl.js

@@ -22,26 +22,14 @@ var reg = /(((^https?:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+(?::\d+)?|(?:
  * @returns {boolean} 值是否为url
  * @example
  *
- * isUrl('');
- * // => false
- *
- * isUrl('8.8.8.8');
- * // => false
- *
- * isUrl('example.com');
- * // => true
- *
- * isUrl('http://example.com');
- * // => true
- *
- * isUrl('https://example.com:8080');
- * // => true
- *
- * isUrl('http://www.example.com/test/123');
- * // => true
- *
- * isUrl('http://www.example.com/test/123?foo=bar');
- * // => true
+ * isUrl(''); // false
+ * isUrl('8.8.8.8'); // false
+ * isUrl('example.com'); // true
+ * isUrl('http://example.com'); // true
+ * isUrl('https://example.com:8080'); // true
+ * isUrl('http://www.example.com/test/123'); // true
+ * isUrl('http://www.example.com/test/123?foo=bar'); // true
+ * 
  */
 
 function isUrl(value) {

package/lib/isVehicle.js

@@ -22,20 +22,15 @@ var reg = /^[京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕
  * @returns {boolean} 值是否为车牌号
  * @example
  *
- * isVehicle('京L12345');
- * // => true
- *
- * isVehicle('粤BD12345');
- * // => true
- *
- * isVehicle('粤BF12345');
- * // => true
- *
- * isVehicle('粤B12345D');
- * // => true
- *
- * isVehicle('粤B12345F');
- * // => true
+ * isVehicle('京L12345'); // true
+ * isVehicle('京L1234学'); // true
+ * isVehicle('BL1234警'); // true
+ * 
+ * // 新能源车牌
+ * isVehicle('粤BD12345'); // true
+ * isVehicle('粤BF12345'); // true
+ * isVehicle('粤B12345D'); // true
+ * isVehicle('粤B12345F'); // true
  *
  */
 

package/lib/isWX.js

@@ -21,11 +21,8 @@ var reg = /^[a-z]([-_a-z0-9]{5,19})+$/i;
  * @returns {boolean} 值是否为微信号
  * @example
  *
- * isWX('a12345');
- * // => true
- *
- * isWX('123');
- * // => false
+ * isWX('a12345'); // true
+ * isWX('123'); // false
  *
  */
 

package/lib/minus.js

@@ -33,14 +33,10 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
  * @returns {number} 差
  * @example
  *
- * minus(1, 0.9);
- * // => 0.1
- *
- * minus(1, 0.9, 0.02);
- * // => 0.08
- *
- * minus(1, 0.9, 0.02, 0.08);
- * // => 0
+ * minus(1, 0.9); // 0.1
+ * minus(1, 0.9, 0.02); // 0.08
+ * minus(1, 0.9, 0.02, 0.08); // 0
+ * 
  */
 function minus() {
   for (var _len = arguments.length, nums = new Array(_len), _key = 0; _key < _len; _key++) {

package/lib/normalizeString.js

@@ -21,6 +21,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  * @param {*} value 待处理的值
  * @returns {string} 规整化的值
  * @example
+ * 
  * normalizeString(); // ''
  * normalizeString(undefined); // ''
  * normalizeString(void 0); // ''
@@ -30,6 +31,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  * normalizeString(NaN); // 'NaN'
  * normalizeString(1); // '1'
  * normalizeString('a'); // 'a'
+ * 
  */
 function normalizeString(value) {
   if ((0, _isNil["default"])(value)) {

package/lib/numberToChinese.js

@@ -162,7 +162,7 @@ function mapNumberChar(num) {
  * @param {Object} [options] 配置项
  * @param {boolean} [options.big5=false] 繁体
  * @param {boolean} [options.unit=true] 计数单位
- * @param {string} [options.decimal="点"] 中文小数点
+ * @param {string} [options.decimal="点"] 中文小数点，繁体字为點
  * @param {string} [options.zero="零"] 设置0。常用配置 〇
  * @param {string} [options.negative="负"] 负数前面的字
  * @param {Object} [options.unitConfig] 节点单位配置
@@ -171,29 +171,21 @@ function mapNumberChar(num) {
  * @returns {string} 中文数字
  * @example
  *
- * numberToChinese(100);
- * // => 一百
- *
- * numberToChinese(100.3);
- * // => 一百点三
+ * numberToChinese(100); // 一百
+ * numberToChinese(100.3); // 一百点三
+ * numberToChinese(1234567890); // 一十二亿三千四百五十六万七千八百九十
+ * numberToChinese(1234567890.11); // 一十二亿三千四百五十六万七千八百九十点一一
  *
  * // 繁体
- * numberToChinese(100, {big5: true});
- * // => 壹佰
- *
- * numberToChinese(100.3, {big5: true});
- * // => 壹佰点叁
- *
- * numberToChinese(1234567890, {big5: true});
- * // => 壹拾贰亿叁仟肆佰伍拾陆万柒仟捌佰玖拾
+ * numberToChinese(100, {big5: true}); // 壹佰
+ * numberToChinese(100.3, {big5: true}); // 壹佰點叁
+ * numberToChinese(1234567890.11, {big5: true}); // 壹拾贰亿叁仟肆佰伍拾陆万柒仟捌佰玖拾點壹壹
  *
  * // 不带计数单位
- * numberToChinese(1990, {unit: false});
- * // => 一九九零
+ * numberToChinese(1990, {unit: false}); // 一九九零
  *
  * // 不带计数单位，修改0
- * numberToChinese(1990, {unit: false, zero:'〇'});
- * // => 一九九〇
+ * numberToChinese(1990, {unit: false, zero:'〇'}); // 一九九〇
  *
  */
 
@@ -205,7 +197,7 @@ function numberToChinese(num) {
       _ref$unit = _ref.unit,
       unit = _ref$unit === void 0 ? true : _ref$unit,
       _ref$decimal = _ref.decimal,
-      decimal = _ref$decimal === void 0 ? '点' : _ref$decimal,
+      decimal = _ref$decimal === void 0 ? '' : _ref$decimal,
       _ref$zero = _ref.zero,
       zero = _ref$zero === void 0 ? '' : _ref$zero,
       _ref$negative = _ref.negative,
@@ -225,9 +217,11 @@ function numberToChinese(num) {
   if (big5) {
     numberChar = big5NumberChar.slice();
     unitChar = big5UnitChar.slice();
+    decimal = decimal || '點';
   } else {
     numberChar = chnNumberChar.slice();
     unitChar = chnUnitChar.slice();
+    decimal = decimal || '点';
   } // 设置节点计数单位，万、亿、万亿
 
 

package/lib/padZero.js

@@ -19,17 +19,18 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  * @param {number} [size=2] 指定字符串长度
  * @returns {string} 用零填充数字到给定长度的字符串
  * @example
- * padZero(5); // '05'
- * padZero('5'); // '05'
+ * padZero(5); // 05
+ * padZero('5'); // 05
  *
- * padZero(12); // '12'
- * padZero('12'); // '12'
+ * padZero(12); // 12
+ * padZero('12'); // 12
  *
- * padZero(688); // '688'
- * padZero('688'); // '688'
+ * padZero(688); // 688
+ * padZero('688'); // 688
  *
- * padZero(688, 5); // '00688'
- * padZero('688', 5); // '00688'
+ * padZero(688, 5); // 00688
+ * padZero('688', 5); // 00688
+ * 
  */
 function padZero(value) {
   var size = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 2;

package/lib/parseIdCard.js

@@ -74,11 +74,11 @@ var Provinces = [// 华北地区：北京市|110000，天津市|120000，河北
  * @param {string} id 身份证号码，支持15位
  * @returns {null|IdCardInfo} null 或 省份、生日、性别，省/市/区/年/月/日/性别编码
  * @example
- * parseIdCard('123456789123456');
- * // => null
+ * 
+ * parseIdCard('123456789123456'); // null
  *
  * // 18位身份证号码
- * parseIdCard('130701199310302288')
+ * parseIdCard('130701199310302288'); 
  * // =>
  * {
  *   birthday: "1993-10-30",

package/lib/plus.js

@@ -33,14 +33,10 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
  * @returns {number} 总和
  * @example
  *
- * plus(0.1, 0.2);
- * // => 0.3
- *
- * plus(0.1, 0.2, 0.3);
- * // => 0.6
- *
- * plus(0.1, 0.2, 0.3, 0.4);
- * // => 1
+ * plus(0.1, 0.2); // 0.3
+ * plus(0.1, 0.2, 0.3); // 0.6
+ * plus(0.1, 0.2, 0.3, 0.4); // 1
+ * 
  */
 function plus() {
   for (var _len = arguments.length, nums = new Array(_len), _key = 0; _key < _len; _key++) {

package/lib/randomString.js

@@ -37,12 +37,14 @@ function internalRandomString() {
  * @param {string} [optionalChars='0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'] 允许的字符，默认为数字和大小写字母
  * @returns {string} 随机字符串
  * @example
+ * 
  * randomString(5); // slk23
  * randomString(8); // 71mHqo2A
  *
  * // 自定义允许的字符
  * randomString(5, 'abc'); // ccbcb
  * randomString(8, 'abcefg'); // bcgcfabg
+ * 
  */
 
 

package/lib/replaceChar.js

@@ -26,33 +26,25 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  * @example
  *
  * // 手机号
- * replaceChar('13000000000');
- * // => 130****0000
+ * replaceChar('13000000000'); // 130****0000
  *
  * // 身份证
- * replaceChar('130701199310302288');
- * // => 130***********2288
+ * replaceChar('130701199310302288'); // 130***********2288
  *
  * // 邮箱
  * const email = '12345@qq.com'
- * replaceChar(email, {start: 2, end: email.indexOf('@'), repeat: 4});
- * // => 12****@qq.com
+ * replaceChar(email, {start: 2, end: email.indexOf('@'), repeat: 4}); // 12****@qq.com
  *
  * // 银行卡号
- * replaceChar('6228480402564890018', {start: 0, end: -4, repeat: 4});
- * // => ****0018
+ * replaceChar('6228480402564890018', {start: 0, end: -4, repeat: 4}); // ****0018
  *
- * // 带格式的银行卡号
- * replaceChar('6228 4804 0256 4890 018', {start: 4, end: -4, exclude: ' '});
- * // => 6228 **** **** **** 018
+ * // 带格式的银行卡号，忽略空字符串
+ * replaceChar('6228 4804 0256 4890 018', {start: 4, end: -4, exclude: ' '}); // 6228 **** **** **** 018
  *
  * // 用户名
- * replaceChar('林某某', {start: 1, end: Infinity, repeat: 2});
- * // => 林**
- * replaceChar('林某', {start: 1, end: Infinity, repeat: 2});
- * // => 林**
- * replaceChar('林某某某', {start: 1, end: Infinity, repeat: 2});
- * // => 林**
+ * replaceChar('林某某', {start: 1, end: Infinity, repeat: 2}); // 林**
+ * replaceChar('林某', {start: 1, end: Infinity, repeat: 2}); // 林**
+ * replaceChar('林某某某', {start: 1, end: Infinity, repeat: 2}); // 林**
  *
  */
 function replaceChar(str) {

package/lib/round.js

@@ -24,14 +24,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  * @returns {number} 四舍五入的数字
  * @example
  *
- * round(4.006);
- * // => 4
- *
- * round(4.006, 2);
- * // => 4.01
- *
- * round(4060, -2);
- * // => 4100
+ * round(4.006); // 4
+ * round(4.006, 2); // 4.01
+ * round(4060, -2); // 4100
+ * 
  */
 function round(num) {
   var precision = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;

package/lib/safeDate.js

@@ -29,12 +29,14 @@ function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || func
  * @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 (中国标准时间)
+ * 
  *
  */
 function safeDate(value) {