util-helpers 4.12.4 → 4.12.7

package/types/src/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/src/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/src/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;

package/types/src/isTWCard.d.ts

@@ -11,12 +11,15 @@ export default isTWCard;
  * @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
  */
 declare function isTWCard(value: any, { loose }?: {
     loose?: boolean | undefined;

package/types/src/isTelephone.d.ts

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

package/types/src/isUrl.d.ts

@@ -10,25 +10,13 @@ export default isUrl;
  * @returns {boolean} 值是否为url
  * @example
  *
- * isUrl('');
- * // => false
+ * 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('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
  */
 declare function isUrl(value: any): boolean;

package/types/src/isVehicle.d.ts

@@ -10,20 +10,15 @@ export default isVehicle;
  * @returns {boolean} 值是否为车牌号
  * @example
  *
- * isVehicle('京L12345');
- * // => true
+ * isVehicle('京L12345'); // true
+ * isVehicle('京L1234学'); // true
+ * isVehicle('BL1234警'); // true
  *
- * isVehicle('粤BD12345');
- * // => true
- *
- * isVehicle('粤BF12345');
- * // => true
- *
- * isVehicle('粤B12345D');
- * // => true
- *
- * isVehicle('粤B12345F');
- * // => true
+ * // 新能源车牌
+ * isVehicle('粤BD12345'); // true
+ * isVehicle('粤BF12345'); // true
+ * isVehicle('粤B12345D'); // true
+ * isVehicle('粤B12345F'); // true
  *
  */
 declare function isVehicle(value: any): boolean;

package/types/src/isWX.d.ts

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

package/types/src/minus.d.ts

@@ -9,13 +9,9 @@ export default minus;
  * @returns {number} 差
  * @example
  *
- * minus(1, 0.9);
- * // => 0.1
+ * 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.02);
- * // => 0.08
- *
- * minus(1, 0.9, 0.02, 0.08);
- * // => 0
  */
 declare function minus(...nums: (number | string)[]): number;

package/types/src/normalizeString.d.ts

@@ -9,6 +9,7 @@ export default normalizeString;
  * @param {*} value 待处理的值
  * @returns {string} 规整化的值
  * @example
+ *
  * normalizeString(); // ''
  * normalizeString(undefined); // ''
  * normalizeString(void 0); // ''
@@ -18,5 +19,6 @@ export default normalizeString;
  * normalizeString(NaN); // 'NaN'
  * normalizeString(1); // '1'
  * normalizeString('a'); // 'a'
+ *
  */
 declare function normalizeString(value: any): string;

package/types/src/numberToChinese.d.ts

@@ -10,7 +10,7 @@ export default numberToChinese;
  * @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] 节点单位配置
@@ -19,29 +19,21 @@ export default numberToChinese;
  * @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:'〇'}); // 一九九〇
  *
  */
 declare function numberToChinese(num: number, { big5, unit, decimal, zero, negative, unitConfig }?: {

package/types/src/padZero.d.ts

@@ -9,16 +9,17 @@ export default padZero;
  * @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'
  */
 declare function padZero(value: string | number, size?: number | undefined): string;

package/types/src/parseIdCard.d.ts

@@ -80,11 +80,11 @@ export type IdCardInfo = {
  * @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/types/src/plus.d.ts

@@ -9,13 +9,9 @@ export default plus;
  * @returns {number} 总和
  * @example
  *
- * plus(0.1, 0.2);
- * // => 0.3
+ * 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);
- * // => 0.6
- *
- * plus(0.1, 0.2, 0.3, 0.4);
- * // => 1
  */
 declare function plus(...nums: (number | string)[]): number;

package/types/src/randomString.d.ts

@@ -9,11 +9,13 @@ export default randomString;
  * @param {string} [optionalChars='0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'] 允许的字符，默认为数字和大小写字母
  * @returns {string} 随机字符串
  * @example
+ *
  * randomString(5); // slk23
  * randomString(8); // 71mHqo2A
  *
  * // 自定义允许的字符
  * randomString(5, 'abc'); // ccbcb
  * randomString(8, 'abcefg'); // bcgcfabg
+ *
  */
 declare function randomString(len?: number | undefined, optionalChars?: string | undefined): string;

package/types/src/replaceChar.d.ts

@@ -16,33 +16,25 @@ export default replaceChar;
  * @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}); // 林**
  *
  */
 declare function replaceChar(str: string, { start, end, char, repeat, exclude }?: {

package/types/src/round.d.ts

@@ -10,13 +10,9 @@ export default round;
  * @returns {number} 四舍五入的数字
  * @example
  *
- * round(4.006);
- * // => 4
+ * round(4.006); // 4
+ * round(4.006, 2); // 4.01
+ * round(4060, -2); // 4100
  *
- * round(4.006, 2);
- * // => 4.01
- *
- * round(4060, -2);
- * // => 4100
  */
 declare function round(num: number | string, precision?: number | undefined): number;

package/types/src/safeDate.d.ts

@@ -11,6 +11,7 @@ export default safeDate;
  * @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 (中国标准时间)
@@ -18,5 +19,6 @@ export default safeDate;
  * safeDate(99, 1); // Mon Feb 01 1999 00:00:00 GMT+0800 (中国标准时间)
  * safeDate(1646711233171); // Tue Mar 08 2022 11:47:13 GMT+0800 (中国标准时间)
  *
+ *
  */
 declare function safeDate(value?: string | number | Date | undefined, ...args: number[]): Date;

package/types/src/setDataURLPrefix.d.ts

@@ -13,6 +13,7 @@ export default setDataURLPrefix;
  * @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=
@@ -20,5 +21,6 @@ export default setDataURLPrefix;
  * setDataURLPrefix(data, 'text/html'); // data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
  * setDataURLPrefix(data, ''); // data:;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
  * setDataURLPrefix(data, '', false); // data:,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ *
  */
 declare function setDataURLPrefix(data: string, mimetype?: string | undefined, base64?: boolean | undefined): string;

package/types/src/times.d.ts

@@ -9,13 +9,9 @@ export default times;
  * @returns {number} 乘积
  * @example
  *
- * times(3, 0.6);
- * // => 1.8
+ * times(3, 0.6); // 1.8
+ * times(3, 0.6, 2); // 3.6
+ * times(3, 0.6, 2, 10); // 36
  *
- * times(3, 0.6, 2);
- * // => 3.6
- *
- * times(3, 0.6, 2, 10);
- * // => 36
  */
 declare function times(...nums: (number | string)[]): number;

package/types/src/waitTime.d.ts

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