util-helpers 4.12.0 → 4.12.3

package/types/src/isPromiseLike.d.ts

@@ -0,0 +1,21 @@
+export default isPromiseLike;
+/**
+ * 检测值是否类似Promise对象
+ *
+ * @static
+ * @alias module:Validator.isPromiseLike
+ * @since 3.8.0
+ * @param {*} obj 要检测的值
+ * @returns {boolean} 是否类似Promise对象
+ * @example
+ *
+ * isPromiseLike([]);
+ * => false
+ *
+ * isPromiseLike({then:()=>{}});
+ * => true
+ *
+ * isPromiseLike(Promise.resolve());
+ * => true
+ */
+declare function isPromiseLike(obj: any): boolean;

package/types/src/isQQ.d.ts

@@ -0,0 +1,19 @@
+export default isQQ;
+/**
+ * 检测值是否为QQ号，非0开头，5至11位数字
+ *
+ * @static
+ * @alias module:Validator.isQQ
+ * @since 1.1.0
+ * @param {*} value 要检测的值
+ * @returns {boolean} 值是否为QQ号
+ * @example
+ *
+ * isQQ('12345');
+ * // => true
+ *
+ * isQQ('123');
+ * // => false
+ *
+ */
+declare function isQQ(value: any): boolean;

package/types/src/isSocialCreditCode.d.ts

@@ -0,0 +1,31 @@
+export default isSocialCreditCode;
+/**
+ * 检测值是否为统一社会信用代码，也叫三证合一组织代码。由18位数字和大写字母组成，不使用I、O、Z、S、V。
+ *
+ * @static
+ * @alias module:Validator.isSocialCreditCode
+ * @see 参考 {@link https://zh.wikisource.org/zh-hans/GB_32100-2015_法人和其他组织统一社会信用代码编码规则|GB 32100-2015 法人和其他组织统一社会信用代码编码规则}
+ * @since 1.1.0
+ * @param {*} value 要检测的值
+ * @param {Object} [options] 配置项
+ * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，如果为false，不校验校验位。
+ * @returns {boolean} 值是否为统一社会信用代码
+ * @example
+ *
+ * isSocialCreditCode('91350100M000100Y43');
+ * // => true
+ *
+ * isSocialCreditCode('91350100M000100Y4A');
+ * // => false
+ *
+ * // 不校验校验位
+ * isSocialCreditCode('91350100M000100Y4A', { checkCode: false });
+ * // => true
+ *
+ * isSocialCreditCode('91350100M000100Y', { checkCode: false });
+ * // => false
+ *
+ */
+declare function isSocialCreditCode(value: any, options?: {
+    checkCode?: boolean | undefined;
+} | undefined): boolean;

package/types/src/isSwiftCode.d.ts

@@ -0,0 +1,22 @@
+export default isSwiftCode;
+/**
+ * 检测值是否为 Swift Code。8位或11位，前6位为大写字母，7-8位为大写字母或数字，9-11位为可选的大写字母或数字。
+ *
+ * @static
+ * @alias module:Validator.isSwiftCode
+ * @see 参考 {@link https://zh.wikipedia.org/wiki/ISO_9362|ISO 9362}
+ * @since 4.9.0
+ * @param {*} value 要检测的值
+ * @returns {boolean} 值是否为 Swift Code
+ * @example
+ *
+ * isSwiftCode('DEUTDEFF') //  true
+ * isSwiftCode('deutdeff') //  false
+ *
+ * isSwiftCode('BKTWTWTP010') //  true
+ * isSwiftCode('010BKTWTWTP') //  false
+ *
+ * isSwiftCode('ICBKCNBJBJM') //  true
+ *
+ */
+declare function isSwiftCode(value: any): boolean;

package/types/src/isTWCard.d.ts

@@ -0,0 +1,23 @@
+export default isTWCard;
+/**
+ * 检测值是否为台湾居民来往大陆通行证，俗称台胞证。
+ *
+ * @static
+ * @alias module:Validator.isTWCard
+ * @since 4.0.0
+ * @see 参考 {@link https://zh.wikipedia.org/wiki/台湾居民来往大陆通行证|台湾居民来往大陆通行证}
+ * @param {*} value 要检测的值
+ * @param {Object} [options] 配置项
+ * @param {boolean} [options.loose=false] 宽松模式。如果为true，表示支持一次性短期通行证
+ * @returns {boolean} 是否为台湾居民来往大陆通行证
+ * @example
+ * isTWCard('12345678') // true
+ * isTWCard('07257456') // true
+ *
+ * // 一次性短期
+ * isTWCard('F290299977') // false
+ * isTWCard('F290299977', { loose: true }) // true
+ */
+declare function isTWCard(value: any, { loose }?: {
+    loose?: boolean | undefined;
+} | undefined): boolean;

package/types/src/isTelephone.d.ts

@@ -0,0 +1,25 @@
+export default isTelephone;
+/**
+ * 检测值是否为固定电话
+ *
+ * @static
+ * @alias module:Validator.isTelephone
+ * @since 1.1.0
+ * @param {*} value 要检测的值
+ * @returns {boolean} 值是否为固定电话
+ * @example
+ *
+ * isTelephone('22033212');
+ * // => true
+ *
+ * isTelephone('021-22033212');
+ * // => true
+ *
+ * isTelephone('021-22033212-123');
+ * // => true
+ *
+ * isTelephone('13000000000');
+ * // => false
+ *
+ */
+declare function isTelephone(value: any): boolean;

package/types/src/isUrl.d.ts

@@ -0,0 +1,34 @@
+export default isUrl;
+/**
+ * 检测值是否为url
+ *
+ * @static
+ * @alias module:Validator.isUrl
+ * @since 3.4.0
+ * @see 参考 {@link https://zh.wikipedia.org/wiki/统一资源定位符|统一资源定位符}
+ * @param {*} value 要检测的值
+ * @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
+ */
+declare function isUrl(value: any): boolean;

package/types/src/isVehicle.d.ts

@@ -0,0 +1,29 @@
+export default isVehicle;
+/**
+ * 检测值是否为车牌号，支持新能源和非新能源车牌
+ *
+ * @static
+ * @alias module:Validator.isVehicle
+ * @see 参考 {@link https://baike.baidu.com/item/车牌号|车牌号}
+ * @since 1.1.0
+ * @param {*} value 要检测的值
+ * @returns {boolean} 值是否为车牌号
+ * @example
+ *
+ * isVehicle('京L12345');
+ * // => 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

@@ -0,0 +1,19 @@
+export default isWX;
+/**
+ * 检测值是否为微信号
+ *
+ * @static
+ * @alias module:Validator.isWX
+ * @since 1.1.0
+ * @param {*} value 要检测的值
+ * @returns {boolean} 值是否为微信号
+ * @example
+ *
+ * isWX('a12345');
+ * // => true
+ *
+ * isWX('123');
+ * // => false
+ *
+ */
+declare function isWX(value: any): boolean;

package/types/src/minus.d.ts

@@ -0,0 +1,21 @@
+export default minus;
+/**
+ * 精确减法，支持多个数相减，减数默认为 0 。
+ *
+ * @static
+ * @alias module:Math.minus
+ * @since 3.1.0
+ * @param {...number|string} nums 相减的数
+ * @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
+ */
+declare function minus(...nums: (number | string)[]): number;

package/types/src/normalizeString.d.ts

@@ -0,0 +1,22 @@
+export default normalizeString;
+/**
+ * 规整化字符串。如果值为 undefined 或 null 将转为空字符串，如果值不是字符串类型将转为字符串。
+ *
+ * @static
+ * @alias module:Processor.normalizeString
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances|String}
+ * @since 4.3.0
+ * @param {*} value 待处理的值
+ * @returns {string} 规整化的值
+ * @example
+ * normalizeString(); // ''
+ * normalizeString(undefined); // ''
+ * normalizeString(void 0); // ''
+ * normalizeString(null); // ''
+ *
+ * normalizeString(true); // 'true'
+ * normalizeString(NaN); // 'NaN'
+ * normalizeString(1); // '1'
+ * normalizeString('a'); // 'a'
+ */
+declare function normalizeString(value: any): string;

package/types/src/numberToChinese.d.ts

@@ -0,0 +1,57 @@
+export default numberToChinese;
+/**
+ * 数字转中文数字
+ * 不在安全数字 -9007199254740991～9007199254740991 内，处理会有异常
+ *
+ * @static
+ * @alias module:Processor.numberToChinese
+ * @since 1.2.0
+ * @param {number} num 数字
+ * @param {Object} [options] 配置项
+ * @param {boolean} [options.big5=false] 繁体
+ * @param {boolean} [options.unit=true] 计数单位
+ * @param {string} [options.decimal="点"] 中文小数点
+ * @param {string} [options.zero="零"] 设置0。常用配置 〇
+ * @param {string} [options.negative="负"] 负数前面的字
+ * @param {Object} [options.unitConfig] 节点单位配置
+ * @param {string} [options.unitConfig.w="万"] 设置计数单位万。常用配置 萬
+ * @param {string} [options.unitConfig.y="亿"] 设置计数单位亿。常用配置 億
+ * @returns {string} 中文数字
+ * @example
+ *
+ * numberToChinese(100);
+ * // => 一百
+ *
+ * numberToChinese(100.3);
+ * // => 一百点三
+ *
+ * // 繁体
+ * numberToChinese(100, {big5: true});
+ * // => 壹佰
+ *
+ * numberToChinese(100.3, {big5: true});
+ * // => 壹佰点叁
+ *
+ * numberToChinese(1234567890, {big5: true});
+ * // => 壹拾贰亿叁仟肆佰伍拾陆万柒仟捌佰玖拾
+ *
+ * // 不带计数单位
+ * numberToChinese(1990, {unit: false});
+ * // => 一九九零
+ *
+ * // 不带计数单位，修改0
+ * numberToChinese(1990, {unit: false, zero:'〇'});
+ * // => 一九九〇
+ *
+ */
+declare function numberToChinese(num: number, { big5, unit, decimal, zero, negative, unitConfig }?: {
+    big5?: boolean | undefined;
+    unit?: boolean | undefined;
+    decimal?: string | undefined;
+    zero?: string | undefined;
+    negative?: string | undefined;
+    unitConfig?: {
+        w?: string | undefined;
+        y?: string | undefined;
+    } | undefined;
+} | undefined): string;

package/types/src/padZero.d.ts

@@ -0,0 +1,24 @@
+export default padZero;
+/**
+ * 前置补零
+ *
+ * @static
+ * @alias module:Processor.padZero
+ * @since 4.7.0
+ * @param {string|number} value 要处理的值
+ * @param {number} [size=2] 指定字符串长度
+ * @returns {string} 用零填充数字到给定长度的字符串
+ * @example
+ * padZero(5); // '05'
+ * padZero('5'); // '05'
+ *
+ * padZero(12); // '12'
+ * padZero('12'); // '12'
+ *
+ * padZero(688); // '688'
+ * padZero('688'); // '688'
+ *
+ * padZero(688, 5); // '00688'
+ * padZero('688', 5); // '00688'
+ */
+declare function padZero(value: string | number, size?: number | undefined): string;

package/types/src/parseIdCard.d.ts

@@ -0,0 +1,107 @@
+export default parseIdCard;
+/**
+ * - 解析身份证原数据
+ */
+export type IdCardOrigin = {
+    /**
+     * - 省份编码
+     */
+    province: string;
+    /**
+     * - 城市编码
+     */
+    city: string;
+    /**
+     * - 地区编码
+     */
+    area: string;
+    /**
+     * - 出生年
+     */
+    year: string;
+    /**
+     * - 出生月
+     */
+    month: string;
+    /**
+     * - 出生日
+     */
+    day: string;
+    /**
+     * - 性别 能整除2为女，否则为男
+     */
+    gender: string;
+};
+/**
+ * - 身份证信息
+ */
+export type IdCardInfo = {
+    /**
+     * - 省份
+     */
+    province: string;
+    /**
+     * - 生日
+     */
+    birthday: string;
+    /**
+     * - 性别
+     */
+    gender: string;
+    /**
+     * - 解析身份证原数据
+     */
+    origin: IdCardOrigin;
+};
+/**
+ * @typedef {Object} IdCardOrigin - 解析身份证原数据
+ * @property {string} province - 省份编码
+ * @property {string} city - 城市编码
+ * @property {string} area - 地区编码
+ * @property {string} year - 出生年
+ * @property {string} month - 出生月
+ * @property {string} day - 出生日
+ * @property {string} gender - 性别 能整除2为女，否则为男
+ */
+/**
+ * @typedef {Object} IdCardInfo - 身份证信息
+ * @property {string} province - 省份
+ * @property {string} birthday - 生日
+ * @property {string} gender - 性别
+ * @property {IdCardOrigin} origin - 解析身份证原数据
+ */
+/**
+ * 解析身份证号码，支持15、18位身份证号码
+ *
+ * @static
+ * @alias module:Processor.parseIdCard
+ * @since 4.0.0
+ * @see 参考 {@link https://baike.baidu.com/item/居民身份证号码|居民身份证号码}
+ * @param {string} id 身份证号码，支持15位
+ * @returns {null|IdCardInfo} null 或 省份、生日、性别，省/市/区/年/月/日/性别编码
+ * @example
+ * parseIdCard('123456789123456');
+ * // => null
+ *
+ * // 18位身份证号码
+ * parseIdCard('130701199310302288')
+ * // =>
+ * {
+ *   birthday: "1993-10-30",
+ *   gender: "女",
+ *   origin: { province: "13", city: "07", area: "01", year: "1993", month: "10", day: "30", gender: "8" },
+ *   province: "河北省"
+ * }
+ *
+ * // 15位身份证号码
+ * parseIdCard('130701931030228');
+ * // =>
+ * {
+ *   birthday: "93-10-30",
+ *   gender: "女",
+ *   origin: { province: "13", city: "07", area: "01", year: "93", month: "10", day: "30", gender: "8" },
+ *   province: "河北省"
+ * }
+ *
+ */
+declare function parseIdCard(id: string): null | IdCardInfo;

package/types/src/plus.d.ts

@@ -0,0 +1,21 @@
+export default plus;
+/**
+ * 精确加法，支持多个数相加，加数默认为 0 。
+ *
+ * @static
+ * @alias module:Math.plus
+ * @since 3.1.0
+ * @param {...number|string} nums 相加的数
+ * @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
+ */
+declare function plus(...nums: (number | string)[]): number;

package/types/src/randomString.d.ts

@@ -0,0 +1,19 @@
+export default randomString;
+/**
+ * 生成随机字符串
+ *
+ * @static
+ * @alias module:Other.randomString
+ * @since 4.8.0
+ * @param {number} [len=0] 长度
+ * @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

@@ -0,0 +1,54 @@
+export default replaceChar;
+/**
+ * 替换字符，应用场景如：脱敏
+ *
+ * @static
+ * @alias module:Processor.replaceChar
+ * @since 1.1.0
+ * @param {string} str 要处理的字符串
+ * @param {Object} [options] 配置项
+ * @param {number} [options.start=3] 开始位置
+ * @param {number} [options.end=-4] 结束位置
+ * @param {string} [options.char="*"] 替换字符
+ * @param {number} [options.repeat] 替换字符的重复次数，默认为替换内容长度，可设置为固定值
+ * @param {string} [options.exclude] 排除字符，如果指定排除项，repeat设置无效
+ * @returns {string} 处理后的字符
+ * @example
+ *
+ * // 手机号
+ * replaceChar('13000000000');
+ * // => 130****0000
+ *
+ * // 身份证
+ * replaceChar('130701199310302288');
+ * // => 130***********2288
+ *
+ * // 邮箱
+ * const email = '12345@qq.com'
+ * replaceChar(email, {start: 2, end: email.indexOf('@'), repeat: 4});
+ * // => 12****@qq.com
+ *
+ * // 银行卡号
+ * replaceChar('6228480402564890018', {start: 0, end: -4, repeat: 4});
+ * // => ****0018
+ *
+ * // 带格式的银行卡号
+ * 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});
+ * // => 林**
+ *
+ */
+declare function replaceChar(str: string, { start, end, char, repeat, exclude }?: {
+    start?: number | undefined;
+    end?: number | undefined;
+    char?: string | undefined;
+    repeat?: number | undefined;
+    exclude?: string | undefined;
+} | undefined): string;

package/types/src/round.d.ts

@@ -0,0 +1,22 @@
+export default round;
+/**
+ * 四舍五入，支持设置精度
+ *
+ * @static
+ * @alias module:Math.round
+ * @since 3.1.0
+ * @param {number|string} num 要四舍五入的数字
+ * @param {number} [precision=0] 四舍五入的精度
+ * @returns {number} 四舍五入的数字
+ * @example
+ *
+ * round(4.006);
+ * // => 4
+ *
+ * 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

@@ -0,0 +1,22 @@
+export default safeDate;
+/**
+ * 创建一个 Date 实例日期对象，同 new Date() 。<br/>
+ * 规避了苹果设备浏览器不支持部分格式（YYYY-MM-DD HH-mm 或 YYYY.MM.DD）。
+ *
+ * @static
+ * @alias module:Processor.safeDate
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Date|Date}
+ * @since 4.4.0
+ * @param {string|number|Date} [value] 日期时间字符串、毫秒数、日期对象
+ * @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 (中国标准时间)
+ *
+ */
+declare function safeDate(value?: string | number | Date | undefined, ...args: number[]): Date;

package/types/src/setDataURLPrefix.d.ts

@@ -0,0 +1,24 @@
+export default setDataURLPrefix;
+/**
+ * 设置 DataURL 前缀、MIME 类型、base64 标识。<br/>
+ * 如果你需要获取DataURL 的 MIME 类型和数据本身，推荐使用 <a href="https://www.npmjs.com/package/data-urls">data-urls</a>。
+ *
+ * @static
+ * @alias module:Processor.setDataURLPrefix
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Basics_of_HTTP/Data_URIs|Data URLs}
+ * @see 参考 {@link https://mimesniff.spec.whatwg.org/#understanding-mime-types|MIME types}
+ * @since 4.1.0
+ * @param {string} data 数据本身
+ * @param {string} [mimetype="image/png"] MIME 类型
+ * @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=
+ * setDataURLPrefix(data, 'image/jpg'); // data:image/jpg;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * 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/strlen.d.ts

@@ -0,0 +1,20 @@
+export default strlen;
+/**
+ * 获取字符长度。中文汉字占2个字符，英文占1个字符，特殊如emoji占4个字符。
+ *
+ * @static
+ * @alias module:Other.strlen
+ * @since 4.10.0
+ * @param {string} str 字符串
+ * @returns {number} 字符长度
+ * @example
+ *
+ * strlen('你好a'); // 5
+ * strlen('你好，世界！'); // 12
+ * strlen('严両丞丽'); // 8
+ * strlen('abcde'); // 5
+ * strlen('𠮷'); // 4
+ * strlen('🍎'); // 4
+ *
+ */
+declare function strlen(str: string): number;

package/types/src/times.d.ts

@@ -0,0 +1,21 @@
+export default times;
+/**
+ * 精确乘法，支持多个数相乘，乘数默认为 1 。
+ *
+ * @static
+ * @alias module:Math.times
+ * @since 3.1.0
+ * @param {...number|string} nums 相乘的数
+ * @returns {number} 乘积
+ * @example
+ *
+ * times(3, 0.6);
+ * // => 1.8
+ *
+ * times(3, 0.6, 2);
+ * // => 3.6
+ *
+ * times(3, 0.6, 2, 10);
+ * // => 36
+ */
+declare function times(...nums: (number | string)[]): number;