util-helpers 4.12.0 → 4.12.1

package/esm/utils/config.js

@@ -1,3 +1,4 @@
+var version = "4.12.1";
 var config = {
   // 禁用warning提示
   disableWarning: true
@@ -14,4 +15,4 @@ function setDisableWarning(bool) {
   config.disableWarning = !!bool;
 }
 
-export { config, setDisableWarning };
+export { config, setDisableWarning, version };

package/lib/index.js

@@ -273,6 +273,12 @@ Object.defineProperty(exports, "setDisableWarning", {
     return _config.setDisableWarning;
   }
 });
+Object.defineProperty(exports, "version", {
+  enumerable: true,
+  get: function get() {
+    return _config.version;
+  }
+});
 
 var _isMobile = _interopRequireDefault(require("./isMobile"));
 

package/lib/utils/config.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.setDisableWarning = setDisableWarning;
-exports.config = void 0;
+exports.version = exports.config = void 0;
+var version = "4.12.1";
+exports.version = version;
 var config = {
   // 禁用warning提示
   disableWarning: true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.12.0",
+  "version": "4.12.1",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -64,9 +64,11 @@
     "@commitlint/config-conventional": "^11.0.0",
     "@rollup/plugin-babel": "^5.3.1",
     "@rollup/plugin-commonjs": "^19.0.0",
+    "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.0.0",
     "@types/jest": "^26.0.23",
     "babel-jest": "^27.0.2",
+    "babel-plugin-inline-json": "^2.1.0",
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
     "docdash": "^1.2.0",

package/types/src/blobToDataURL.d.ts

@@ -0,0 +1,25 @@
+export default blobToDataURL;
+/**
+ * 将 Blob 或 File 对象转成 data:URL 格式的 Base64 字符串。
+ *
+ * @static
+ * @alias module:Processor.blobToDataURL
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader/readAsDataURL|FileReader.readAsDataURL()}
+ * @since 4.1.0
+ * @param {Blob} blob Blob 或 File 对象
+ * @returns {Promise<string>} data:URL 格式的 Base64 字符串。
+ * @example
+ * const aFileParts = ['<a id="a"><b id="b">hey!</b></a>']; // 一个包含DOMString的数组
+ * const htmlBlob = new Blob(aFileParts, { type: 'text/html' }); // 得到 blob
+ *
+ * blobToDataURL(htmlBlob).then(data=>{
+ *   console.log(data); // data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * });
+ *
+ * const textBlob = new Blob(aFileParts, { type: 'text/plain' });
+ *
+ * blobToDataURL(textBlob).then(data=>{
+ *   console.log(data); // data:text/plain;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
+ * });
+ */
+declare function blobToDataURL(blob: Blob): Promise<string>;

package/types/src/bytesToSize.d.ts

@@ -0,0 +1,24 @@
+export default bytesToSize;
+/**
+ * 字节转换存储单位，保留2位小数点
+ *
+ * @static
+ * @alias module:Processor.bytesToSize
+ * @since 3.8.0
+ * @param {number} bytes 字节大小
+ * @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
+ */
+declare function bytesToSize(bytes: number): string;

package/types/src/calculateCursorPosition.d.ts

@@ -0,0 +1,26 @@
+export default calculateCursorPosition;
+/**
+ * 计算输入框的值格式化后光标位置
+ *
+ * @static
+ * @alias module:Other.calculateCursorPosition
+ * @since 4.6.0
+ * @see 格式化手机号码 {@link https://doly-dev.github.io/util-helpers/module-Processor.html#.formatMobile|formatMobile}
+ * @see 格式化银行卡号 {@link https://doly-dev.github.io/util-helpers/module-Processor.html#.formatBankCard|formatBankCard}
+ * @see h5示例 {@link https://2950v9.csb.app/|点击查看}
+ * @see react示例 {@link https://33ccy9.csb.app/|点击查看}
+ * @param {number} prevPos 赋值前的光标位置，onChange/onInput的光标位置 e.target.selectionEnd
+ * @param {string} prevCtrlValue 上一个格式化后的值
+ * @param {string} rawValue 当前输入原值
+ * @param {string} ctrlValue 当前格式化后的值
+ * @param {Object} [options] 配置项
+ * @param {string[]|string} [options.placeholderChar=' '] 占位符
+ * @param {RegExp} [options.maskReg=/\D/g] 需要遮盖的字符规则。默认去掉非数字，意味着 ctrlValue 需要去掉非数字。
+ * @param {'mobile'|'bankCard'} [options.type] 格式化类型，内置手机号码和银行卡号特殊处理
+ * @returns {number} 格式化后的光标位置
+ */
+declare function calculateCursorPosition(prevPos: number, prevCtrlValue: string, rawValue: string, ctrlValue: string, { placeholderChar, maskReg, type }?: {
+    placeholderChar?: string | string[] | undefined;
+    maskReg?: RegExp | undefined;
+    type?: "mobile" | "bankCard" | undefined;
+} | undefined): number;

package/types/src/dataURLToBlob.d.ts

@@ -0,0 +1,15 @@
+export default dataURLToBlob;
+/**
+ * 将 DataURL 转为 Blob 对象
+ *
+ * @static
+ * @alias module:Processor.dataURLToBlob
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Glossary/Base64|Base64}
+ * @since 4.1.0
+ * @param {string} dataurl data: 协议的URL
+ * @returns {Blob} Blob 对象
+ * @example
+ * const dataurl = 'data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=';
+ * dataURLToBlob(dataurl);
+ */
+declare function dataURLToBlob(dataurl: string): Blob;

package/types/src/divide.d.ts

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

package/types/src/formatBankCard.d.ts

@@ -0,0 +1,35 @@
+export default formatBankCard;
+/**
+ * 格式化银行卡号
+ *
+ * @static
+ * @alias module:Processor.formatBankCard
+ * @since 1.1.0
+ * @param {string} bankCardNo 要处理的字符串
+ * @param {Object} [options] 配置项
+ * @param {string} [options.char=" "] 间隔字符
+ * @param {number} [options.length=4] 间隔长度
+ * @returns {string} 格式化的银行卡号
+ * @example
+ *
+ * // 19位银行卡
+ * formatBankCard('6228480402564890018');
+ * // => 6228 4804 0256 4890 018
+ *
+ * // 16位银行卡
+ * formatBankCard('6228480402564890');
+ * // => 6228 4804 0256 4890
+ *
+ * // 脱敏银行卡
+ * formatBankCard('6228********890');
+ * // => 6228 **** **** 890
+ *
+ * // 16位银行卡，"-"间隔
+ * formatBankCard('6228480402564890', {char: '-'});
+ * // => 6228-4804-0256-4890
+ *
+ */
+declare function formatBankCard(bankCardNo?: string, { char, length }?: {
+    char?: string | undefined;
+    length?: number | undefined;
+} | undefined): string;

package/types/src/formatMobile.d.ts

@@ -0,0 +1,27 @@
+export default formatMobile;
+/**
+ * 格式化手机号码
+ *
+ * @static
+ * @alias module:Processor.formatMobile
+ * @since 4.5.0
+ * @param {string} mobileNo 手机号码
+ * @param {object} [options] 配置项
+ * @param {string} [options.char=' '] 间隔字符
+ * @returns {string} 格式化后的手机号码
+ * @example
+ * formatMobile('13345678900') // '133 4567 8900'
+ * formatMobile('13345678900', { char: '-' }) // '133-4567-8900'
+ *
+ * // 脱敏手机号码
+ * formatMobile('133****1234') // '133 **** 1234'
+ * formatMobile('133****1234', { char: '-' }) // '133-****-1234'
+ *
+ * // 手机号码位数不够
+ * formatMobile('133') // '133'
+ * formatMobile('133456') // '133 456'
+ * formatMobile('13345678') // '133 4567 8'
+ */
+declare function formatMobile(mobileNo: string, { char }?: {
+    char?: string | undefined;
+} | undefined): string;

package/types/src/formatMoney.d.ts

@@ -0,0 +1,50 @@
+export default formatMoney;
+/**
+ * 格式化金额
+ *
+ * @static
+ * @alias module:Processor.formatMoney
+ * @since 1.1.0
+ * @param {string | number} num 需转换金额 (最大：9007199254740991 最小： -9007199254740991)
+ * @param {Object} [options] - 金额格式化配置
+ * @param {string | number} [options.precision=2] - 保留位数 （最高：10位）
+ * @param {string} [options.symbol] - 货币符号
+ * @param {string} [options.thousand=","] - 千分位符号
+ * @param {string} [options.decimal="."] - 小数位符号
+ * @returns {string} 格式化的金额
+ * @example
+ *
+ * // 整数
+ * formatMoney('1000');
+ * // => 1,000.00
+ *
+ * // 小数（默认保留2位小数）
+ * formatMoney('3000.03');
+ * // => 3,000.03
+ *
+ * // 保留4位小数
+ * formatMoney('3000.0300', { precision: 4 });
+ * // => 3,000.0300
+ *
+ * // 保留10位小数
+ * formatMoney('1500.2', { precision: 10 });
+ * // => 1,500.2000000000
+ *
+ * // 自定义单位符号
+ * formatMoney(1000.00, { symbol: '$' });
+ * // => $1,000.00
+ *
+ * // 自定义千位分割符（默认','）
+ * formatMoney(1000.00, { thousand: '|' });
+ * // => 1|000.00
+ *
+ * // 自定义小数位分割符(默认'.')
+ * formatMoney(1000.00, { decimal: '&' });
+ * // => 1,000&00
+ */
+declare function formatMoney(num: string | number, { precision, symbol, thousand, decimal }?: {
+    precision?: string | number | undefined;
+    symbol?: string | undefined;
+    thousand?: string | undefined;
+    decimal?: string | undefined;
+} | undefined): string;

package/types/src/index.d.ts

@@ -0,0 +1,45 @@
+export { default as isMobile } from "./isMobile";
+export { default as isTelephone } from "./isTelephone";
+export { default as isPostcode } from "./isPostcode";
+export { default as isIdCard } from "./isIdCard";
+export { default as isEmail } from "./isEmail";
+export { default as isQQ } from "./isQQ";
+export { default as isWX } from "./isWX";
+export { default as isVehicle } from "./isVehicle";
+export { default as isBankCard } from "./isBankCard";
+export { default as isSocialCreditCode } from "./isSocialCreditCode";
+export { default as isPassword } from "./isPassword";
+export { default as isPassport } from "./isPassport";
+export { default as isChinese } from "./isChinese";
+export { default as isIPv4 } from "./isIPv4";
+export { default as isIPv6 } from "./isIPv6";
+export { default as isUrl } from "./isUrl";
+export { default as isBusinessLicense } from "./isBusinessLicense";
+export { default as validatePassword } from "./validatePassword";
+export { default as isPromiseLike } from "./isPromiseLike";
+export { default as isHMCard } from "./isHMCard";
+export { default as isTWCard } from "./isTWCard";
+export { default as isSwiftCode } from "./isSwiftCode";
+export { default as formatMoney } from "./formatMoney";
+export { default as formatBankCard } from "./formatBankCard";
+export { default as replaceChar } from "./replaceChar";
+export { default as numberToChinese } from "./numberToChinese";
+export { default as bytesToSize } from "./bytesToSize";
+export { default as parseIdCard } from "./parseIdCard";
+export { default as blobToDataURL } from "./blobToDataURL";
+export { default as dataURLToBlob } from "./dataURLToBlob";
+export { default as setDataURLPrefix } from "./setDataURLPrefix";
+export { default as normalizeString } from "./normalizeString";
+export { default as safeDate } from "./safeDate";
+export { default as formatMobile } from "./formatMobile";
+export { default as padZero } from "./padZero";
+export { default as plus } from "./plus";
+export { default as minus } from "./minus";
+export { default as times } from "./times";
+export { default as divide } from "./divide";
+export { default as round } from "./round";
+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, version } from "./utils/config";

package/types/src/isBankCard.d.ts

@@ -0,0 +1,32 @@
+export default isBankCard;
+/**
+ * 检测值是否为银行卡号。正常模式（非0开头，10~21位数字）宽松模式（8~30位数字）
+ *
+ * @static
+ * @alias module:Validator.isBankCard
+ * @see 参考 {@link https://kf.qq.com/faq/170112ABnm6b170112FvquAn.html|常用银行账号位数参考}
+ * @since 1.1.0
+ * @param {*} value 要检测的值
+ * @param {Object} [options] 配置项
+ * @param {boolean} [options.loose=false] 宽松模式，8~30位数字
+ * @param {boolean} [options.luhn=false] 使用 Luhn 算法校验校验码
+ * @returns {boolean} 值是否为银行卡号
+ * @example
+ *
+ * isBankCard('6228480402564890018');
+ * // => true
+ *
+ * isBankCard('6228480402564890');
+ * // => true
+ *
+ * isBankCard('123456789');
+ * // => false
+ *
+ * isBankCard('123456789', { loose: true });
+ * // => true
+ *
+ */
+declare function isBankCard(value: any, { loose, luhn }?: {
+    loose?: boolean | undefined;
+    luhn?: boolean | undefined;
+} | undefined): boolean;

package/types/src/isBusinessLicense.d.ts

@@ -0,0 +1,29 @@
+export default isBusinessLicense;
+/**
+ * 检测值是否为营业执照号，也叫工商注册号。由14位数字本体码和1位数字校验码组成，其中本体码从左至右依次为：6位首次登记机关码、8位顺序码。
+ *
+ * @static
+ * @alias module:Validator.isBusinessLicense
+ * @see 参考 {@link https://wenku.baidu.com/view/19873704cc1755270722087c.html|GS15—2006 工商行政管理市场主体注册号编制规则}
+ * @since 3.5.0
+ * @param {*} value 要检测的值
+ * @param {Object} [options] 配置项
+ * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，如果为false，不校验校验位。
+ * @returns {boolean} 值是否为营业执照号
+ * @example
+ *
+ * isBusinessLicense('310115600985533');
+ * // => true
+ *
+ * isBusinessLicense('310115600985535');
+ * // => false
+ *
+ * isBusinessLicense('310115600985535', { checkCode: false });
+ * // => true
+ *
+ * isBusinessLicense('31011560098', { checkCode: false });
+ * // => false
+ */
+declare function isBusinessLicense(value: any, options?: {
+    checkCode?: boolean | undefined;
+} | undefined): boolean;

package/types/src/isChinese.d.ts

@@ -0,0 +1,41 @@
+export default isChinese;
+/**
+ * 检测值是否为中文
+ *
+ * @static
+ * @alias module:Validator.isChinese
+ * @since 1.1.0
+ * @see 参考 {@link http://www.unicode.org/reports/tr38/#BlockListing|4.4 Listing of Characters Covered by the Unihan Database}
+ * @param {*} value 要检测的值
+ * @param {Object} [options] 配置项
+ * @param {boolean} [options.loose=false] 宽松模式。如果为true，只要包含中文即为true
+ * @param {boolean} [options.useExtend=false] 使用统一表意文字扩展A-F。注意：如果不支持 `RegExp.prototype.unicode`，扩展字符集将自动不生效，如IE浏览器。
+ * @returns {boolean} 值是否为中文
+ * @example
+ *
+ * isChinese('林某某');
+ * // => true
+ *
+ * isChinese('林A');
+ * // => false
+ *
+ * // 宽松模式，只要包含中文即为true
+ * 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
+ */
+declare function isChinese(value: any, { loose, useExtend }?: {
+    loose?: boolean | undefined;
+    useExtend?: boolean | undefined;
+} | undefined): boolean;

package/types/src/isEmail.d.ts

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

package/types/src/isHMCard.d.ts

@@ -0,0 +1,24 @@
+export default isHMCard;
+/**
+ * 检测值是否为港澳居民来往内地通行证，俗称回乡证或回乡卡。
+ *
+ * @static
+ * @alias module:Validator.isHMCard
+ * @since 4.0.0
+ * @see 参考 {@link https://zh.wikipedia.org/wiki/港澳居民来往内地通行证|港澳居民来往内地通行证}
+ * @param {*} value 要检测的值
+ * @returns {boolean} 是否为港澳居民来往内地通行证
+ * @example
+ * // 第一代 11 位
+ * 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
+ */
+declare function isHMCard(value: any): boolean;

package/types/src/isIPv4.d.ts

@@ -0,0 +1,25 @@
+export default isIPv4;
+/**
+ * 检测值是否为ipv4
+ *
+ * @static
+ * @alias module:Validator.isIPv4
+ * @since 1.1.0
+ * @param {*} value 要检测的值
+ * @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
+ *
+ */
+declare function isIPv4(value: any): boolean;

package/types/src/isIPv6.d.ts

@@ -0,0 +1,50 @@
+export default isIPv6;
+/**
+ * 检测值是否为ipv6
+ *
+ * @static
+ * @alias module:Validator.isIPv6
+ * @since 1.1.0
+ * @param {*} value 要检测的值
+ * @returns {boolean} 值是否为ipv6
+ * @example
+ *
+ * // 冒分十六进制表示法
+ * 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
+ *
+ * // 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
+ *
+ * // 内嵌IPv4地址表示法
+ * 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/src/isIdCard.d.ts

@@ -0,0 +1,34 @@
+export default isIdCard;
+/**
+ * 检测值是否为18位身份证号码。<br/>宽松模式下，支持15位身份证号码
+ *
+ * @static
+ * @alias module:Validator.isIdCard
+ * @since 1.1.0
+ * @param {*} value 要检测的值
+ * @param {Object} [options] 配置项
+ * @param {boolean} [options.loose=false] 宽松模式，支持15位身份证号码
+ * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，仅支持18位身份证号码
+ * @returns {boolean} 值是否为身份证号
+ * @example
+ *
+ * isIdCard('130701199310302288');
+ * // => true
+ *
+ * isIdCard('13070119931030228X');
+ * // => false
+ *
+ * isIdCard('13070119931030228X', { checkCode: false }); // 不校验校验码
+ * // => true
+ *
+ * isIdCard('320311770706001');
+ * // => false
+ *
+ * isIdCard('320311770706001', { loose: true });
+ * // => true
+ *
+ */
+declare function isIdCard(value: any, { loose, checkCode }?: {
+    loose?: boolean | undefined;
+    checkCode?: boolean | undefined;
+} | undefined): boolean;

package/types/src/isMobile.d.ts

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

package/types/src/isPassport.d.ts

@@ -0,0 +1,21 @@
+export default isPassport;
+/**
+ * 检测值是否为护照号
+ * 支持普通护照(E*)、外交护照(DE)、公务护照(SE)、公务普通护照(PE)、香港特区护照(K/KJ/H*)、澳门特区护照(MA/MB/M*)，注意不区分大小写
+ *
+ * @static
+ * @alias module:Validator.isPassport
+ * @see 参考 {@link https://zh.wikipedia.org/wiki/中华人民共和国护照#个人资料页|中华人民共和国护照#个人资料页}
+ * @since 1.1.0
+ * @param {*} value 要检测的值
+ * @returns {boolean} 值是否为护照号
+ * @example
+ *
+ * isPassport('E12345678');
+ * // => true
+ *
+ * isPassport('abc');
+ * // => false
+ *
+ */
+declare function isPassport(value: any): boolean;