util-helpers 4.4.0 → 4.5.0

package/esm/formatMobile.js

@@ -0,0 +1,38 @@
+import normalizeString from './normalizeString';
+/**
+ * 格式化手机号码
+ *
+ * @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'
+ */
+
+function formatMobile(mobileNo) {
+  var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+      _ref$char = _ref["char"],
+      _char = _ref$char === void 0 ? ' ' : _ref$char;
+
+  var regChar = new RegExp(_char, 'g');
+  var realValue = normalizeString(mobileNo).replace(regChar, '').substring(0, 11);
+
+  if (realValue.length > 7) {
+    return realValue.replace(/^(...)(....)/g, "$1".concat(_char, "$2").concat(_char));
+  }
+
+  if (realValue.length > 3) {
+    return realValue.replace(/^(...)/g, "$1".concat(_char));
+  }
+
+  return realValue;
+}
+
+export default formatMobile;

package/esm/index.js

@@ -43,6 +43,7 @@ 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';
 /**
  * 数学计算，修正浮点数计算问题
  *

package/esm/isHMCard.js

@@ -10,6 +10,18 @@ var regHMCard = /^[hm]{1}([0-9]{10}|[0-9]{8})$/i;
  * @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
  */
 
 function isHMCard(value) {

package/esm/isIdCard.js

@@ -8,7 +8,7 @@ var regIdCard = /^[1-9]\d{5}(19|20)?\d{2}((0[1-9])|(1[012]))(([0-2][1-9])|10|20|
  * @see 参考 {@link https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码|中华人民共和国公民身份号码}
  * @see 参考 {@link https://baike.baidu.com/item/居民身份证号码|居民身份证号码}
  * @param {string} id 身份证号码
- * @returns 校验码是否正确
+ * @returns {boolean} 校验码是否正确
  */
 
 function check(id) {

package/esm/isTWCard.js

@@ -10,6 +10,12 @@ var regTWCard = /^(\d{8}|[\da-z]{10})$/i;
  * @see 参考 {@link https://zh.wikipedia.org/wiki/台湾居民来往大陆通行证|台湾居民来往大陆通行证}
  * @param {*} value 要检测的值
  * @returns {boolean} 是否为台湾居民来往大陆通行证
+ * @example
+ * isTWCard('12345678') // true
+ * isTWCard('07257456') // true
+ *
+ * // 一次性短期
+ * isTWCard('F290299977') // true
  */
 
 function isTWCard(value) {

package/esm/parseIdCard.js

@@ -38,38 +38,58 @@ var Provinces = [// 华北地区：北京市|110000，天津市|120000，河北
 //   ['8', '港澳地区']
 // ];
 
+/**
+ * @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 或 省份、生日、性别，省/市/区/年/月/日/性别编码
+ * @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: "河北省"
-}
+ *   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: "河北省"
-}
- * 
+ *   birthday: "93-10-30",
+ *   gender: "女",
+ *   origin: { province: "13", city: "07", area: "01", year: "93", month: "10", day: "30", gender: "8" },
+ *   province: "河北省"
+ * }
+ *
  */
 
 function parseIdCard(id) {

package/esm/safeDate.js

@@ -2,7 +2,8 @@ import _construct from "@babel/runtime/helpers/construct";
 import isNil from './utils/type/isNil'; // TODO: 函数重载，类型参照 Date
 
 /**
- * 创建一个 Date 实例，同 new Date() 。<br/><br/>主要是规避了 iphone 设备浏览器不支持部分格式（YYYY-MM-DD HH-mm 或 YYYY.MM.DD）。
+ * 创建一个 Date 实例日期对象，同 new Date() 。<br/>
+ * 规避了苹果设备浏览器不支持部分格式（YYYY-MM-DD HH-mm 或 YYYY.MM.DD）。
  *
  * @static
  * @alias module:Processor.safeDate
@@ -10,7 +11,7 @@ import isNil from './utils/type/isNil'; // TODO: 函数重载，类型参照 Dat
  * @since 4.4.0
  * @param {string|number|Date} [value] 日期时间字符串、毫秒数、日期对象
  * @param {...number} args 月/日/时/分/秒/毫秒
- * @returns {Date} Date 实例
+ * @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 (中国标准时间)

package/esm/setDataURLPrefix.js

@@ -1,6 +1,5 @@
 /**
- * 设置 DataURL 前缀、MIME 类型、base64 标识。<br/><br/>
- *
+ * 设置 DataURL 前缀、MIME 类型、base64 标识。<br/>
  * 如果你需要获取DataURL 的 MIME 类型和数据本身，推荐使用 <a href="https://www.npmjs.com/package/data-urls">data-urls</a>。
  *
  * @static

package/esm/validatePassword.js

@@ -118,6 +118,22 @@ function hasUnallowableCharacter(val) {
   });
   return ret;
 }
+/**
+ * @typedef {Object} PasswordContaines - 验证密码的包含内容
+ * @property {boolean} number - 包含数字
+ * @property {boolean} lowerCaseLetter - 包含小写字母
+ * @property {boolean} upperCaseLetter - 包含大写字母
+ * @property {boolean} specialCharacter - 包含特殊字符
+ * @property {boolean} unallowableCharacter - 包含非法字符
+ */
+
+/**
+ * @typedef {Object} ValidatePasswordReturn - 验证结果
+ * @property {boolean} validated - 验证结果，根据密码强度、是否包含非法字符得出
+ * @property {number} level - 强度级别，包含数字/大小写字母/特殊字符
+ * @property {PasswordContaines} containes - 包含内容
+ */
+
 /**
  * 验证密码（数字、大小写字母、特殊字符、非法字符）
  *
@@ -130,7 +146,7 @@ function hasUnallowableCharacter(val) {
  * @param {number} [options.level=2] 密码强度 1-包含一种字符 2-包含两种字符 3-包含三种字符。（大写字母、小写字母、数字、特殊字符）
  * @param {boolean} [options.ignoreCase=false] 是否忽略大小写，为 ture 时，大小写字母视为一种字符
  * @param {string} [options.special="!@#$%^&*()-=_+[]\|{},./?<>~"] 支持的特殊字符
- * @returns 验证结果
+ * @returns {ValidatePasswordReturn} 验证结果
  * @example
  *
  * validatePassword('a12345678');

package/lib/formatBankCard.js

@@ -51,9 +51,8 @@ function formatBankCard() {
   var reg = new RegExp("(.{".concat(length, "})"), 'g');
   var regChar = new RegExp("".concat(_char), 'g');
   var realValue = (0, _normalizeString["default"])(bankCardNo).replace(regChar, '');
-  var needRemoveLastChar = realValue.length % length === 0;
   var str = realValue.replace(reg, "$1".concat(_char));
-  return needRemoveLastChar ? str.substring(0, str.length - 1) : str;
+  return realValue.length % length === 0 ? str.substring(0, str.length - 1) : str;
 }
 
 var _default = formatBankCard;

package/lib/formatMobile.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _normalizeString = _interopRequireDefault(require("./normalizeString"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+/**
+ * 格式化手机号码
+ *
+ * @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'
+ */
+function formatMobile(mobileNo) {
+  var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+      _ref$char = _ref["char"],
+      _char = _ref$char === void 0 ? ' ' : _ref$char;
+
+  var regChar = new RegExp(_char, 'g');
+  var realValue = (0, _normalizeString["default"])(mobileNo).replace(regChar, '').substring(0, 11);
+
+  if (realValue.length > 7) {
+    return realValue.replace(/^(...)(....)/g, "$1".concat(_char, "$2").concat(_char));
+  }
+
+  if (realValue.length > 3) {
+    return realValue.replace(/^(...)/g, "$1".concat(_char));
+  }
+
+  return realValue;
+}
+
+var _default = formatMobile;
+exports["default"] = _default;

package/lib/index.js

@@ -195,6 +195,12 @@ Object.defineProperty(exports, "safeDate", {
     return _safeDate["default"];
   }
 });
+Object.defineProperty(exports, "formatMobile", {
+  enumerable: true,
+  get: function get() {
+    return _formatMobile["default"];
+  }
+});
 Object.defineProperty(exports, "plus", {
   enumerable: true,
   get: function get() {
@@ -302,6 +308,8 @@ var _normalizeString = _interopRequireDefault(require("./normalizeString"));
 
 var _safeDate = _interopRequireDefault(require("./safeDate"));
 
+var _formatMobile = _interopRequireDefault(require("./formatMobile"));
+
 var _plus = _interopRequireDefault(require("./plus"));
 
 var _minus = _interopRequireDefault(require("./minus"));

package/lib/isHMCard.js

@@ -20,6 +20,18 @@ var regHMCard = /^[hm]{1}([0-9]{10}|[0-9]{8})$/i;
  * @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
  */
 
 function isHMCard(value) {

package/lib/isIdCard.js

@@ -18,7 +18,7 @@ var regIdCard = /^[1-9]\d{5}(19|20)?\d{2}((0[1-9])|(1[012]))(([0-2][1-9])|10|20|
  * @see 参考 {@link https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码|中华人民共和国公民身份号码}
  * @see 参考 {@link https://baike.baidu.com/item/居民身份证号码|居民身份证号码}
  * @param {string} id 身份证号码
- * @returns 校验码是否正确
+ * @returns {boolean} 校验码是否正确
  */
 
 function check(id) {

package/lib/isTWCard.js

@@ -20,6 +20,12 @@ var regTWCard = /^(\d{8}|[\da-z]{10})$/i;
  * @see 参考 {@link https://zh.wikipedia.org/wiki/台湾居民来往大陆通行证|台湾居民来往大陆通行证}
  * @param {*} value 要检测的值
  * @returns {boolean} 是否为台湾居民来往大陆通行证
+ * @example
+ * isTWCard('12345678') // true
+ * isTWCard('07257456') // true
+ *
+ * // 一次性短期
+ * isTWCard('F290299977') // true
  */
 
 function isTWCard(value) {

package/lib/parseIdCard.js

@@ -49,38 +49,58 @@ var Provinces = [// 华北地区：北京市|110000，天津市|120000，河北
 //   ['8', '港澳地区']
 // ];
 
+/**
+ * @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 或 省份、生日、性别，省/市/区/年/月/日/性别编码
+ * @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: "河北省"
-}
+ *   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: "河北省"
-}
- * 
+ *   birthday: "93-10-30",
+ *   gender: "女",
+ *   origin: { province: "13", city: "07", area: "01", year: "93", month: "10", day: "30", gender: "8" },
+ *   province: "河北省"
+ * }
+ *
  */
 
 function parseIdCard(id) {

package/lib/safeDate.js

@@ -18,7 +18,8 @@ function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || func
 // TODO: 函数重载，类型参照 Date
 
 /**
- * 创建一个 Date 实例，同 new Date() 。<br/><br/>主要是规避了 iphone 设备浏览器不支持部分格式（YYYY-MM-DD HH-mm 或 YYYY.MM.DD）。
+ * 创建一个 Date 实例日期对象，同 new Date() 。<br/>
+ * 规避了苹果设备浏览器不支持部分格式（YYYY-MM-DD HH-mm 或 YYYY.MM.DD）。
  *
  * @static
  * @alias module:Processor.safeDate
@@ -26,7 +27,7 @@ function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || func
  * @since 4.4.0
  * @param {string|number|Date} [value] 日期时间字符串、毫秒数、日期对象
  * @param {...number} args 月/日/时/分/秒/毫秒
- * @returns {Date} Date 实例
+ * @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 (中国标准时间)

package/lib/setDataURLPrefix.js

@@ -6,8 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 
 /**
- * 设置 DataURL 前缀、MIME 类型、base64 标识。<br/><br/>
- *
+ * 设置 DataURL 前缀、MIME 类型、base64 标识。<br/>
  * 如果你需要获取DataURL 的 MIME 类型和数据本身，推荐使用 <a href="https://www.npmjs.com/package/data-urls">data-urls</a>。
  *
  * @static

package/lib/validatePassword.js

@@ -126,6 +126,22 @@ function hasUnallowableCharacter(val) {
   });
   return ret;
 }
+/**
+ * @typedef {Object} PasswordContaines - 验证密码的包含内容
+ * @property {boolean} number - 包含数字
+ * @property {boolean} lowerCaseLetter - 包含小写字母
+ * @property {boolean} upperCaseLetter - 包含大写字母
+ * @property {boolean} specialCharacter - 包含特殊字符
+ * @property {boolean} unallowableCharacter - 包含非法字符
+ */
+
+/**
+ * @typedef {Object} ValidatePasswordReturn - 验证结果
+ * @property {boolean} validated - 验证结果，根据密码强度、是否包含非法字符得出
+ * @property {number} level - 强度级别，包含数字/大小写字母/特殊字符
+ * @property {PasswordContaines} containes - 包含内容
+ */
+
 /**
  * 验证密码（数字、大小写字母、特殊字符、非法字符）
  *
@@ -138,7 +154,7 @@ function hasUnallowableCharacter(val) {
  * @param {number} [options.level=2] 密码强度 1-包含一种字符 2-包含两种字符 3-包含三种字符。（大写字母、小写字母、数字、特殊字符）
  * @param {boolean} [options.ignoreCase=false] 是否忽略大小写，为 ture 时，大小写字母视为一种字符
  * @param {string} [options.special="!@#$%^&*()-=_+[]\|{},./?<>~"] 支持的特殊字符
- * @returns 验证结果
+ * @returns {ValidatePasswordReturn} 验证结果
  * @example
  *
  * validatePassword('a12345678');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",

package/types/formatMobile.d.ts

@@ -0,0 +1,20 @@
+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'
+ */
+declare function formatMobile(mobileNo: string, { char }?: {
+    char?: string | undefined;
+} | undefined): string;

package/types/index.d.ts

@@ -30,6 +30,7 @@ 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 plus } from "./plus";
 export { default as minus } from "./minus";
 export { default as times } from "./times";

package/types/isHMCard.d.ts

@@ -8,5 +8,17 @@ export default isHMCard;
  * @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/isTWCard.d.ts

@@ -8,5 +8,11 @@ export default isTWCard;
  * @see 参考 {@link https://zh.wikipedia.org/wiki/台湾居民来往大陆通行证|台湾居民来往大陆通行证}
  * @param {*} value 要检测的值
  * @returns {boolean} 是否为台湾居民来往大陆通行证
+ * @example
+ * isTWCard('12345678') // true
+ * isTWCard('07257456') // true
+ *
+ * // 一次性短期
+ * isTWCard('F290299977') // true
  */
 declare function isTWCard(value: any): boolean;