util-helpers 4.12.6 → 4.12.7

package/esm/minus.js

@@ -11,14 +11,10 @@ import times from './times';
  * @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() {

package/esm/normalizeString.js

@@ -10,6 +10,7 @@ import convertToString from './utils/convertToString';
  * @param {*} value 待处理的值
  * @returns {string} 规整化的值
  * @example
+ * 
  * normalizeString(); // ''
  * normalizeString(undefined); // ''
  * normalizeString(void 0); // ''
@@ -19,6 +20,7 @@ import convertToString from './utils/convertToString';
  * normalizeString(NaN); // 'NaN'
  * normalizeString(1); // '1'
  * normalizeString('a'); // 'a'
+ * 
  */
 
 function normalizeString(value) {

package/esm/numberToChinese.js

@@ -151,7 +151,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] 节点单位配置
@@ -160,29 +160,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:'〇'}); // 一九九〇
  *
  */
 
@@ -194,7 +186,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,
@@ -214,9 +206,11 @@ function numberToChinese(num) {
   if (big5) {
     numberChar = big5NumberChar.slice();
     unitChar = big5UnitChar.slice();
+    decimal = decimal || '點';
   } else {
     numberChar = chnNumberChar.slice();
     unitChar = chnUnitChar.slice();
+    decimal = decimal || '点';
   } // 设置节点计数单位，万、亿、万亿
 
 

package/esm/padZero.js

@@ -9,17 +9,18 @@ import normalizeString from './normalizeString';
  * @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) {

package/esm/parseIdCard.js

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

@@ -11,14 +11,10 @@ import times from './times';
  * @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() {

package/esm/randomString.js

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

@@ -16,33 +16,25 @@ import normalizeString from './normalizeString';
  * @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}); // 林**
  *
  */
 

package/esm/round.js

@@ -12,14 +12,10 @@ import { transformEffectiveNumber } from './utils/math.util';
  * @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) {

package/esm/safeDate.js

@@ -13,12 +13,14 @@ import isNil from './utils/type/isNil'; // TODO: 函数重载，类型参照 Dat
  * @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 (中国标准时间)
+ * 
  *
  */
 

package/esm/setDataURLPrefix.js

@@ -12,6 +12,7 @@
  * @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=
@@ -19,6 +20,7 @@
  * 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/esm/times.js

@@ -10,14 +10,10 @@ import { digitLength, float2Fixed, checkBoundary, transformEffectiveNumber } fro
  * @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() {

package/esm/utils/config.js

@@ -1,4 +1,4 @@
-var version = "4.12.6";
+var version = "4.12.7";
 var config = {
   // 禁用warning提示
   disableWarning: true

package/esm/waitTime.js

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

package/lib/bytesToSize.js

@@ -15,17 +15,11 @@ exports["default"] = void 0;
  * @returns {string} 存储单位值
  * @example
  *
- * bytesToSize(0);
- * // => 0 B
- *
- * bytesToSize(1024);
- * // => 1 KB
- *
- * bytesToSize(3.213243*1024*1024);
- * // => 3.21 MB
- *
- * bytesToSize(1024*1024*1024);
- * // => 1 GB
+ * bytesToSize(0); // 0 B
+ * bytesToSize(1024); // 1 KB
+ * bytesToSize(3.213243*1024*1024); // 3.21 MB
+ * bytesToSize(1024*1024*1024); // 1 GB
+ * 
  */
 function bytesToSize(bytes) {
   var numBytes = typeof bytes !== 'number' ? Number(bytes) : bytes;

package/lib/calculateCursorPosition.js

@@ -9,7 +9,7 @@ var _normalizeString = _interopRequireDefault(require("./normalizeString"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 
-// ref: https://github.com/ant-design/ant-design-mobile/blob/v2/components/input-item/index.tsx#L240
+// 参考了: https://github.com/ant-design/ant-design-mobile/blob/v2/components/input-item/index.tsx#L240
 
 /**
  * 计算输入框的值格式化后光标位置

package/lib/dataURLToBlob.js

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

@@ -41,6 +41,7 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
  * 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() {
   for (var _len = arguments.length, nums = new Array(_len), _key = 0; _key < _len; _key++) {

package/lib/formatBankCard.js

@@ -23,20 +23,16 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  * @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
  *
  */
 function formatBankCard() {

package/lib/formatMobile.js

@@ -20,17 +20,19 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  * @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) {
   var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},

package/lib/formatMoney.js

@@ -116,32 +116,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/lib/isBankCard.js

@@ -46,17 +46,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/lib/isBusinessLicense.js

@@ -55,17 +55,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/lib/isChinese.js

@@ -48,27 +48,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/lib/isEmail.js

@@ -21,11 +21,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/lib/isHMCard.js

@@ -22,16 +22,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/lib/isIPv4.js

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