util-helpers 4.12.4 → 4.12.7

package/esm/calculateCursorPosition.js

@@ -1,4 +1,4 @@
-import normalizeString from './normalizeString'; // ref: https://github.com/ant-design/ant-design-mobile/blob/v2/components/input-item/index.tsx#L240
+import normalizeString from './normalizeString'; // 参考了: https://github.com/ant-design/ant-design-mobile/blob/v2/components/input-item/index.tsx#L240
 
 /**
  * 计算输入框的值格式化后光标位置

package/esm/dataURLToBlob.js

@@ -9,7 +9,7 @@
  * @returns {Blob} Blob 对象
  * @example
  * const dataurl = 'data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=';
- * dataURLToBlob(dataurl);
+ * dataURLToBlob(dataurl); // Blob {size: 32, type: 'text/html'}
  */
 function dataURLToBlob(dataurl) {
   var arr = dataurl.split(','); // @ts-ignore

package/esm/divide.js

@@ -19,6 +19,7 @@ import times from './times';
  * divide(); // NaN  如果没有传入参数，被除数默认为 undefined 。 Number(undefined) 转换为 NaN ，NaN/1 = NaN
  * divide(null); // 0  Number(null) 转换为 0 ， 0/1 = 0
  * divide('1.5 ', 0.5); // 3  Number('1.5 ') 转换为 1.5 ，1.5/0.5 = 3
+ * 
  */
 
 function divide() {

package/esm/formatBankCard.js

@@ -13,20 +13,16 @@ import normalizeString from './normalizeString';
  * @example
  *
  * // 19位银行卡
- * formatBankCard('6228480402564890018');
- * // => 6228 4804 0256 4890 018
+ * formatBankCard('6228480402564890018'); // 6228 4804 0256 4890 018
  *
  * // 16位银行卡
- * formatBankCard('6228480402564890');
- * // => 6228 4804 0256 4890
+ * formatBankCard('6228480402564890'); // 6228 4804 0256 4890
  *
  * // 脱敏银行卡
- * formatBankCard('6228********890');
- * // => 6228 **** **** 890
+ * formatBankCard('6228********890'); // 6228 **** **** 890
  *
  * // 16位银行卡，"-"间隔
- * formatBankCard('6228480402564890', {char: '-'});
- * // => 6228-4804-0256-4890
+ * formatBankCard('6228480402564890', {char: '-'}); // 6228-4804-0256-4890
  *
  */
 

package/esm/formatMobile.js

@@ -10,17 +10,19 @@ import normalizeString from './normalizeString';
  * @param {string} [options.char=' '] 间隔字符
  * @returns {string} 格式化后的手机号码
  * @example
- * formatMobile('13345678900') // '133 4567 8900'
- * formatMobile('13345678900', { char: '-' }) // '133-4567-8900'
+ * 
+ * formatMobile('13345678900'); // 133 4567 8900
+ * formatMobile('13345678900', { char: '-' }); // 133-4567-8900
  *
  * // 脱敏手机号码
- * formatMobile('133****1234') // '133 **** 1234'
- * formatMobile('133****1234', { char: '-' }) // '133-****-1234'
+ * formatMobile('133****1234'); // 133 **** 1234
+ * formatMobile('133****1234', { char: '-' }); // 133-****-1234
  *
  * // 手机号码位数不够
- * formatMobile('133') // '133'
- * formatMobile('133456') // '133 456'
- * formatMobile('13345678') // '133 4567 8'
+ * formatMobile('133'); // 133
+ * formatMobile('133456'); // 133 456
+ * formatMobile('13345678'); // 133 4567 8
+ * 
  */
 
 function formatMobile(mobileNo) {

package/esm/formatMoney.js

@@ -94,32 +94,26 @@ function formatDec(decStr, precision, decimal) {
  * @example
  *
  * // 整数
- * formatMoney('1000');
- * // => 1,000.00
+ * formatMoney('1000'); // 1,000.00
  *
  * // 小数（默认保留2位小数）
- * formatMoney('3000.03');
- * // => 3,000.03
+ * formatMoney('3000.03'); // 3,000.03
  *
  * // 保留4位小数
- * formatMoney('3000.0300', { precision: 4 });
- * // => 3,000.0300
+ * formatMoney('3000.0300', { precision: 4 }); // 3,000.0300
  *
  * // 保留10位小数
- * formatMoney('1500.2', { precision: 10 });
- * // => 1,500.2000000000
+ * formatMoney('1500.2', { precision: 10 }); // 1,500.2000000000
  *
  * // 自定义单位符号
- * formatMoney(1000.00, { symbol: '$' });
- * // => $1,000.00
+ * formatMoney(1000.00, { symbol: '$' }); // $1,000.00
  *
  * // 自定义千位分割符（默认','）
- * formatMoney(1000.00, { thousand: '|' });
- * // => 1|000.00
+ * formatMoney(1000.00, { thousand: '|' }); // 1|000.00
  *
  * // 自定义小数位分割符(默认'.')
- * formatMoney(1000.00, { decimal: '&' });
- * // => 1,000&00
+ * formatMoney(1000.00, { decimal: '&' }); // 1,000&00
+ * 
  */
 
 

package/esm/isBankCard.js

@@ -36,17 +36,12 @@ function sumCheckCode(numStr) {
  * @returns {boolean} 值是否为银行卡号
  * @example
  *
- * isBankCard('6228480402564890018');
- * // => true
- *
- * isBankCard('6228480402564890');
- * // => true
- *
- * isBankCard('123456789');
- * // => false
- *
- * isBankCard('123456789', { loose: true });
- * // => true
+ * isBankCard('6228480402564890018'); // true
+ * isBankCard('6228480402564890'); // true
+ * isBankCard('123456789'); // false
+ * 
+ * // 宽松模式
+ * isBankCard('123456789', { loose: true }); // true
  *
  */
 

package/esm/isBusinessLicense.js

@@ -45,17 +45,14 @@ function sumCheckCode(preCode) {
  * @returns {boolean} 值是否为营业执照号
  * @example
  *
- * isBusinessLicense('310115600985533');
- * // => true
+ * isBusinessLicense('310115600985533'); // true
+ * isBusinessLicense('310115600985535'); // false
  *
- * isBusinessLicense('310115600985535');
- * // => false
- *
- * isBusinessLicense('310115600985535', { checkCode: false });
- * // => true
- *
- * isBusinessLicense('31011560098', { checkCode: false });
- * // => false
+ * // 不校验验证码，长度和类型还是有校验
+ * isBusinessLicense('310115600985535', { checkCode: false }); // true
+ * isBusinessLicense('ac115600985535', { checkCode: false }); // false
+ * isBusinessLicense('31011560098', { checkCode: false }); // false
+ * 
  */
 
 

package/esm/isChinese.js

@@ -38,27 +38,20 @@ var supportRegExpUnicode = RegExp.prototype.hasOwnProperty('unicode');
  * @returns {boolean} 值是否为中文
  * @example
  *
- * isChinese('林某某');
- * // => true
- *
- * isChinese('林A');
- * // => false
+ * isChinese('林某某'); // true
+ * isChinese('林A'); // false
  *
  * // 宽松模式，只要包含中文即为true
- * isChinese('林A', { loose: true });
- * // => true
- *
- * isChinese('A林A', { loose: true });
- * // => true
- *
- * isChinese('𠮷');
- * // => false
+ * isChinese('林A', { loose: true }); // true
+ * isChinese('A林A', { loose: true }); // true
  *
+ * // 扩展字符集的字符
+ * isChinese('𠮷'); // false
+ * 
  * // 使用中文扩展字符集，需要浏览器支持 RegExp.prototype.unicode 才生效。
- * isChinese('𠮷', { useExtend: true });
- * // => true
- * isChinese('𠮷aa', { useExtend: true, loose: true });
- * // => true
+ * isChinese('𠮷', { useExtend: true }); // true
+ * isChinese('𠮷aa', { useExtend: true, loose: true }); // true
+ * 
  */
 
 function isChinese(value) {

package/esm/isEmail.js

@@ -11,11 +11,8 @@ var reg = /^[\da-z]+([\-\.\_]?[\da-z]+)*@[\da-z]+([\-\.]?[\da-z]+)*(\.[a-z]{2,})
  * @returns {boolean} 值是否为Email
  * @example
  *
- * isEmail('1232@qq.com');
- * // => true
- *
- * isEmail('123@');
- * // => false
+ * isEmail('1232@qq.com'); // true
+ * isEmail('123@'); // false
  *
  */
 

package/esm/isHMCard.js

@@ -12,16 +12,16 @@ var regHMCard = /^[hm]{1}([0-9]{10}|[0-9]{8})$/i;
  * @returns {boolean} 是否为港澳居民来往内地通行证
  * @example
  * // 第一代 11 位
- * isHMCard('h3203117707') // true
- * isHMCard('H3203117707') // true
- * isHMCard('m3203117707') // true
- * isHMCard('M3203117707') // true
+ * isHMCard('h3203117707'); // true
+ * isHMCard('H3203117707'); // true
+ * isHMCard('m3203117707'); // true
+ * isHMCard('M3203117707'); // true
  *
  * // 第二代 9 位
- * isHMCard('h32031177') // true
- * isHMCard('H32031177') // true
- * isHMCard('m32031177') // true
- * isHMCard('M32031177') // true
+ * isHMCard('h32031177'); // true
+ * isHMCard('H32031177'); // true
+ * isHMCard('m32031177'); // true
+ * isHMCard('M32031177'); // true
  */
 
 function isHMCard(value) {

package/esm/isIPv4.js

@@ -11,17 +11,10 @@ var reg = /^((\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.){3}(\d{1,2}|1\d\d|2[0-4]\d|25[0-
  * @returns {boolean} 值是否为ipv4
  * @example
  *
- * isIPv4('192.168.1.1');
- * // => true
- *
- * isIPv4('255.255.255.255');
- * // => true
- *
- * isIPv4('256.256.256.256');
- * // => false
- *
- * isIPv4('0.0');
- * // => false
+ * isIPv4('192.168.1.1'); // true
+ * isIPv4('255.255.255.255'); // true
+ * isIPv4('256.256.256.256'); // false
+ * isIPv4('0.0'); // false
  *
  */
 

package/esm/isIPv6.js

@@ -12,41 +12,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/esm/isIdCard.js

@@ -39,20 +39,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/esm/isMobile.js

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

package/esm/isPassport.js

@@ -13,11 +13,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/esm/isPassword.js

@@ -17,27 +17,20 @@ import validatePassword from './validatePassword';
  * @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) {

package/esm/isPostcode.js

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

package/esm/isPromiseLike.js

@@ -10,14 +10,10 @@ import _typeof from "@babel/runtime/helpers/typeof";
  * @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/esm/isQQ.js

@@ -11,11 +11,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/esm/isSocialCreditCode.js

@@ -49,18 +49,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/esm/isSwiftCode.js

@@ -11,13 +11,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/esm/isTWCard.js

@@ -15,12 +15,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/esm/isTelephone.js

@@ -11,17 +11,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/esm/isUrl.js

@@ -12,26 +12,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/esm/isVehicle.js

@@ -12,20 +12,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/esm/isWX.js

@@ -11,11 +11,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
  *
  */