util-helpers 4.12.6 → 4.12.8

package/lib/setDataURLPrefix.js

@@ -19,6 +19,7 @@ exports["default"] = void 0;
  * @param {boolean} [base64=true] 添加 base64 标识
  * @returns {string} DataURL 格式的字符串
  * @example
+ * 
  * const data = 'PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=';
  * setDataURLPrefix(data); // data:image/png;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
  * setDataURLPrefix(data, 'image/png', false); // data:image/png,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
@@ -26,6 +27,7 @@ exports["default"] = void 0;
  * setDataURLPrefix(data, 'text/html'); // data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
  * setDataURLPrefix(data, ''); // data:;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
  * setDataURLPrefix(data, '', false); // data:,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * 
  */
 function setDataURLPrefix(data) {
   var mimetype = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'image/png';

package/lib/times.js

@@ -29,14 +29,10 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
  * @returns {number} 乘积
  * @example
  *
- * times(3, 0.6);
- * // => 1.8
- *
- * times(3, 0.6, 2);
- * // => 3.6
- *
- * times(3, 0.6, 2, 10);
- * // => 36
+ * times(3, 0.6); // 1.8
+ * times(3, 0.6, 2); // 3.6
+ * times(3, 0.6, 2, 10); // 36
+ * 
  */
 function times() {
   for (var _len = arguments.length, nums = new Array(_len), _key = 0; _key < _len; _key++) {

package/lib/utils/config.js

@@ -5,7 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.setDisableWarning = setDisableWarning;
 exports.version = exports.config = void 0;
-var version = "4.12.6";
+// @ts-ignore
+var version = "4.12.8";
 exports.version = version;
 var config = {
   // 禁用warning提示

package/lib/waitTime.js

@@ -14,6 +14,7 @@ exports["default"] = void 0;
  * @param {number} [time=1000] 延时时间，单位毫秒
  * @returns {Promise<void>}
  * @example
+ * 
  * const test = async ()=>{
  *   await waitTime();
  *   // do something
@@ -21,7 +22,8 @@ exports["default"] = void 0;
  *
  * waitTime(500).then(()=>{
  *   // do something
- * })
+ * });
+ * 
  */
 function waitTime() {
   var time = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1000;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.12.6",
+  "version": "4.12.8",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -19,7 +19,7 @@
     "build:dist": "rm -rf dist && rollup -c",
     "build:doc": "npm run doc",
     "doc": "rm -rf docs && jsdoc -c conf.json",
-    "open:doc": "open ./docs/index.html",
+    "doc:open": "open ./docs/index.html",
     "prettier": "prettier --write 'src/**/*.js' && prettier --write 'test/**/*.js'",
     "lint-staged": "lint-staged",
     "lint-staged:js": "eslint --ext .js",
@@ -28,7 +28,7 @@
     "lint:fix": "eslint src --ext .js --fix",
     "commit": "cz",
     "prepublishOnly": "npm test && npm run build",
-    "types": "tsc"
+    "types": "rm -rf types && tsc"
   },
   "repository": {
     "type": "git",

package/types/bytesToSize.d.ts

@@ -9,16 +9,10 @@ export default bytesToSize;
  * @returns {string} 存储单位值
  * @example
  *
- * bytesToSize(0);
- * // => 0 B
+ * bytesToSize(0); // 0 B
+ * bytesToSize(1024); // 1 KB
+ * bytesToSize(3.213243*1024*1024); // 3.21 MB
+ * bytesToSize(1024*1024*1024); // 1 GB
  *
- * bytesToSize(1024);
- * // => 1 KB
- *
- * bytesToSize(3.213243*1024*1024);
- * // => 3.21 MB
- *
- * bytesToSize(1024*1024*1024);
- * // => 1 GB
  */
 declare function bytesToSize(bytes: number): string;

package/types/dataURLToBlob.d.ts

@@ -10,6 +10,6 @@ export default dataURLToBlob;
  * @returns {Blob} Blob 对象
  * @example
  * const dataurl = 'data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=';
- * dataURLToBlob(dataurl);
+ * dataURLToBlob(dataurl); // Blob {size: 32, type: 'text/html'}
  */
 declare function dataURLToBlob(dataurl: string): Blob;

package/types/divide.d.ts

@@ -1,21 +1,22 @@
 export default divide;
 /**
- * 精确除法，支持多个数相除
+ * 精确除法，支持多个数相除，除数默认为 1 。
  *
  * @static
  * @alias module:Math.divide
  * @since 3.1.0
- * @param {...number|string} nums 除数和被除数
+ * @param {...number|string} nums 被除数和除数
  * @returns {number} 商数
  * @example
  *
- * divide(1.21, 1.1);
- * // => 1.1
+ * divide(1.21); // 1.21 除数默认为 1 ，即 1.21/1 = 1.21
+ * divide(1.21, 1.1); // 1.1
+ * divide(1000, 10, 10); // 10
+ * divide(1000, 10, 10, 10); // 1
  *
- * divide(1000, 10, 10);
- * // => 10
+ * 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
  *
- * divide(1000, 10, 10, 10);
- * // => 1
  */
 declare function divide(...nums: (number | string)[]): number;

package/types/formatBankCard.d.ts

@@ -13,20 +13,16 @@ export default formatBankCard;
  * @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
  *
  */
 declare function formatBankCard(bankCardNo?: string, { char, length }?: {

package/types/formatMobile.d.ts

@@ -10,17 +10,19 @@ export default formatMobile;
  * @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
+ *
  */
 declare function formatMobile(mobileNo: string, { char }?: {
     char?: string | undefined;

package/types/formatMoney.d.ts

@@ -15,32 +15,26 @@ export default formatMoney;
  * @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
+ *
  */
 declare function formatMoney(num: string | number, { precision, symbol, thousand, decimal }?: {
     precision?: string | number | undefined;

package/types/index.d.ts

@@ -42,4 +42,4 @@ export { default as waitTime } from "./waitTime";
 export { default as calculateCursorPosition } from "./calculateCursorPosition";
 export { default as randomString } from "./randomString";
 export { default as strlen } from "./strlen";
-export { setDisableWarning } from "./utils/config";
+export { setDisableWarning, version } from "./utils/config";

package/types/isBankCard.d.ts

@@ -13,17 +13,12 @@ export default isBankCard;
  * @returns {boolean} 值是否为银行卡号
  * @example
  *
- * isBankCard('6228480402564890018');
- * // => true
+ * isBankCard('6228480402564890018'); // true
+ * isBankCard('6228480402564890'); // true
+ * isBankCard('123456789'); // false
  *
- * isBankCard('6228480402564890');
- * // => true
- *
- * isBankCard('123456789');
- * // => false
- *
- * isBankCard('123456789', { loose: true });
- * // => true
+ * // 宽松模式
+ * isBankCard('123456789', { loose: true }); // true
  *
  */
 declare function isBankCard(value: any, { loose, luhn }?: {

package/types/isBusinessLicense.d.ts

@@ -12,17 +12,14 @@ export default isBusinessLicense;
  * @returns {boolean} 值是否为营业执照号
  * @example
  *
- * isBusinessLicense('310115600985533');
- * // => true
+ * isBusinessLicense('310115600985533'); // true
+ * isBusinessLicense('310115600985535'); // false
  *
- * isBusinessLicense('310115600985535');
- * // => false
+ * // 不校验验证码，长度和类型还是有校验
+ * isBusinessLicense('310115600985535', { checkCode: false }); // true
+ * isBusinessLicense('ac115600985535', { checkCode: false }); // false
+ * isBusinessLicense('31011560098', { checkCode: false }); // false
  *
- * isBusinessLicense('310115600985535', { checkCode: false });
- * // => true
- *
- * isBusinessLicense('31011560098', { checkCode: false });
- * // => false
  */
 declare function isBusinessLicense(value: any, options?: {
     checkCode?: boolean | undefined;

package/types/isChinese.d.ts

@@ -13,27 +13,20 @@ export default isChinese;
  * @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('林A', { loose: true }); // true
+ * isChinese('A林A', { loose: true }); // true
  *
- * isChinese('𠮷');
- * // => false
+ * // 扩展字符集的字符
+ * 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
+ *
  */
 declare function isChinese(value: any, { loose, useExtend }?: {
     loose?: boolean | undefined;

package/types/isEmail.d.ts

@@ -9,11 +9,8 @@ export default isEmail;
  * @returns {boolean} 值是否为Email
  * @example
  *
- * isEmail('1232@qq.com');
- * // => true
- *
- * isEmail('123@');
- * // => false
+ * isEmail('1232@qq.com'); // true
+ * isEmail('123@'); // false
  *
  */
 declare function isEmail(value: any): boolean;

package/types/isHMCard.d.ts

@@ -10,15 +10,15 @@ export default isHMCard;
  * @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
  */
 declare function isHMCard(value: any): boolean;

package/types/isIPv4.d.ts

@@ -9,17 +9,10 @@ export default isIPv4;
  * @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
  *
  */
 declare function isIPv4(value: any): boolean;

package/types/isIPv6.d.ts

@@ -10,41 +10,23 @@ export default isIPv6;
  * @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
  *
  */
 declare function isIPv6(value: any): boolean;

package/types/isIdCard.d.ts

@@ -12,20 +12,17 @@ export default isIdCard;
  * @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
+ * // 默认不支持15位身份证号码
+ * isIdCard('320311770706001'); // false
  *
- * isIdCard('320311770706001');
- * // => false
- *
- * isIdCard('320311770706001', { loose: true });
- * // => true
+ * // 宽松模式，支持15位身份证号
+ * isIdCard('320311770706001', { loose: true }); // true
  *
  */
 declare function isIdCard(value: any, { loose, checkCode }?: {

package/types/isMobile.d.ts

@@ -9,11 +9,8 @@ export default isMobile;
  * @returns {boolean} 值是否为手机号码
  * @example
  *
- * isMobile('13000000000');
- * // => true
- *
- * isMobile('13000');
- * // => false
+ * isMobile('13000000000'); // true
+ * isMobile('13000'); // false
  *
  */
 declare function isMobile(value: any): boolean;

package/types/isPassport.d.ts

@@ -11,11 +11,8 @@ export default isPassport;
  * @returns {boolean} 值是否为护照号
  * @example
  *
- * isPassport('E12345678');
- * // => true
- *
- * isPassport('abc');
- * // => false
+ * isPassport('E12345678'); // true
+ * isPassport('abc'); // false
  *
  */
 declare function isPassport(value: any): boolean;

package/types/isPassword.d.ts

@@ -17,27 +17,20 @@ export default isPassword;
  * @returns {boolean} 值是否符合密码强度
  * @example
  *
- * isPassword('a12345678');
- * // => true
+ * isPassword('a12345678'); // true
  *
- * isPassword('a12345678', {level: 3});
- * // => false
+ * // 3级密码强度
+ * isPassword('a12345678', {level: 3}); // false
+ * isPassword('Aa12345678', {level: 3}); // true
  *
- * isPassword('Aa12345678', {level: 3});
- * // => true
+ * // 3级密码强度，大小写字符仅计算1级强度
+ * isPassword('Aa12345678', {level: 3, ignoreCase: true}); // false
+ * isPassword('_Aa12345678', {level: 3, ignoreCase: true}); // true
  *
- * isPassword('Aa12345678', {level: 3, ignoreCase: true});
- * // => false
+ * // 仅支持 数字、字母、特殊字符，其他非法字符如中文字符是校验不通过的
+ * isPassword('_Aa一二三45678', {level: 3, ignoreCase: true}); // false
+ * 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
  */
 declare function isPassword(value: any, { level, ignoreCase, special }?: {
     level?: number | undefined;

package/types/isPostcode.d.ts

@@ -9,11 +9,8 @@ export default isPostcode;
  * @returns {boolean} 值是否为邮政编码
  * @example
  *
- * isPostcode('101111');
- * // => true
- *
- * isPostcode('123');
- * // => false
+ * isPostcode('101111'); // true
+ * isPostcode('123'); // false
  *
  */
 declare function isPostcode(value: any): boolean;

package/types/isPromiseLike.d.ts

@@ -9,13 +9,9 @@ export default isPromiseLike;
  * @returns {boolean} 是否类似Promise对象
  * @example
  *
- * isPromiseLike([]);
- * => false
+ * isPromiseLike([]); // false
+ * isPromiseLike({ then: () => { } }); // true
+ * isPromiseLike(Promise.resolve()); // true
  *
- * isPromiseLike({then:()=>{}});
- * => true
- *
- * isPromiseLike(Promise.resolve());
- * => true
  */
 declare function isPromiseLike(obj: any): boolean;

package/types/isQQ.d.ts

@@ -9,11 +9,8 @@ export default isQQ;
  * @returns {boolean} 值是否为QQ号
  * @example
  *
- * isQQ('12345');
- * // => true
- *
- * isQQ('123');
- * // => false
+ * isQQ('12345'); // true
+ * isQQ('123'); // false
  *
  */
 declare function isQQ(value: any): boolean;

package/types/isSocialCreditCode.d.ts

@@ -12,18 +12,13 @@ export default isSocialCreditCode;
  * @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
  *
  */
 declare function isSocialCreditCode(value: any, options?: {

package/types/isSwiftCode.d.ts

@@ -10,13 +10,13 @@ export default isSwiftCode;
  * @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
  *
  */
 declare function isSwiftCode(value: any): boolean;