util-helpers 4.4.0 → 4.5.0

package/types/parseIdCard.d.ts

@@ -1,4 +1,75 @@
 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位身份证号码
  *
@@ -7,7 +78,7 @@ export default 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
@@ -16,33 +87,21 @@ export default parseIdCard;
  * 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: "河北省"
+ * }
  *
  */
-declare function parseIdCard(id: string): {
-    province: string;
-    birthday: string;
-    gender: string;
-    origin: {
-        province: string;
-        city: string;
-        area: string;
-        year: string;
-        month: string;
-        day: string;
-        gender: string;
-    };
-} | null;
+declare function parseIdCard(id: string): null | IdCardInfo;

package/types/safeDate.d.ts

@@ -1,6 +1,7 @@
 export default safeDate;
 /**
- * 创建一个 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
@@ -8,7 +9,7 @@ export default safeDate;
  * @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/types/setDataURLPrefix.d.ts

@@ -1,7 +1,6 @@
 export default setDataURLPrefix;
 /**
- * 设置 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/types/validatePassword.d.ts

@@ -1,4 +1,60 @@
 export default validatePassword;
+/**
+ * - 验证密码的包含内容
+ */
+export type PasswordContaines = {
+    /**
+     * - 包含数字
+     */
+    number: boolean;
+    /**
+     * - 包含小写字母
+     */
+    lowerCaseLetter: boolean;
+    /**
+     * - 包含大写字母
+     */
+    upperCaseLetter: boolean;
+    /**
+     * - 包含特殊字符
+     */
+    specialCharacter: boolean;
+    /**
+     * - 包含非法字符
+     */
+    unallowableCharacter: boolean;
+};
+/**
+ * - 验证结果
+ */
+export type ValidatePasswordReturn = {
+    /**
+     * - 验证结果，根据密码强度、是否包含非法字符得出
+     */
+    validated: boolean;
+    /**
+     * - 强度级别，包含数字/大小写字母/特殊字符
+     */
+    level: number;
+    /**
+     * - 包含内容
+     */
+    containes: PasswordContaines;
+};
+/**
+ * @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 - 包含内容
+ */
 /**
  * 验证密码（数字、大小写字母、特殊字符、非法字符）
  *
@@ -11,7 +67,7 @@ export default validatePassword;
  * @param {number} [options.level=2] 密码强度 1-包含一种字符 2-包含两种字符 3-包含三种字符。（大写字母、小写字母、数字、特殊字符）
  * @param {boolean} [options.ignoreCase=false] 是否忽略大小写，为 ture 时，大小写字母视为一种字符
  * @param {string} [options.special="!@#$%^&*()-=_+[]\|{},./?<>~"] 支持的特殊字符
- * @returns 验证结果
+ * @returns {ValidatePasswordReturn} 验证结果
  * @example
  *
  * validatePassword('a12345678');
@@ -75,14 +131,4 @@ declare function validatePassword(value: string, { level, ignoreCase, special }?
     level?: number | undefined;
     ignoreCase?: boolean | undefined;
     special?: string | undefined;
-} | undefined): {
-    validated: boolean;
-    level: number;
-    containes: {
-        number: boolean;
-        lowerCaseLetter: boolean;
-        upperCaseLetter: boolean;
-        specialCharacter: boolean;
-        unallowableCharacter: boolean;
-    };
-};
+} | undefined): ValidatePasswordReturn;