util-helpers 4.12.0 → 4.12.1

package/types/src/validatePassword.d.ts

@@ -0,0 +1,134 @@
+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 - 包含内容
+ */
+/**
+ * 验证密码（数字、大小写字母、特殊字符、非法字符）
+ *
+ * @see 参考 {@link https://baike.baidu.com/item/ASCII#3|ASCII}
+ * @static
+ * @alias module:Validator.validatePassword
+ * @since 3.7.0
+ * @param {string} value 要检测的值
+ * @param {Object} [options] 配置项
+ * @param {number} [options.level=2] 密码强度 1-包含一种字符 2-包含两种字符 3-包含三种字符。（大写字母、小写字母、数字、特殊字符）
+ * @param {boolean} [options.ignoreCase=false] 是否忽略大小写，为 ture 时，大小写字母视为一种字符
+ * @param {string} [options.special="!@#$%^&*()-=_+[]\|{},./?<>~"] 支持的特殊字符
+ * @returns {ValidatePasswordReturn} 验证结果
+ * @example
+ *
+ * validatePassword('a12345678');
+ * // =>
+ * {
+ *   validated: true, // 验证结果，根据密码强度、是否包含非法字符得出
+ *   level: 2, // 强度级别
+ *   containes: {
+ *     number: true, // 包含数字
+ *     lowerCaseLetter: true, // 包含小写字母
+ *     upperCaseLetter: false, // 包含大写字母
+ *     specialCharacter: false, // 包含特殊字符
+ *     unallowableCharacter: false // 包含非法字符
+ *   }
+ * }
+ *
+ * validatePassword('a12345678', { level: 3 });
+ * // =>
+ * {
+ *   validated: false,
+ *   level: 2,
+ *   containes: {
+ *     number: true,
+ *     lowerCaseLetter: true,
+ *     upperCaseLetter: false,
+ *     specialCharacter: false,
+ *     unallowableCharacter: false
+ *   }
+ * }
+ *
+ * validatePassword('_Aa一二三45678', { level: 3, ignoreCase: true });
+ * // =>
+ * {
+ *   validated: false,
+ *   level: 3,
+ *   containes: {
+ *     number: true,
+ *     lowerCaseLetter: true,
+ *     upperCaseLetter: true,
+ *     specialCharacter: true,
+ *     unallowableCharacter: true
+ *   }
+ * }
+ *
+ * // 自定义特殊字符
+ * validatePassword('_Aa一二三45678', { level: 3, ignoreCase: true, special: '_一二三' });
+ * // =>
+ * {
+ *   validated: true,
+ *   level: 3,
+ *   containes: {
+ *     number: true,
+ *     lowerCaseLetter: true,
+ *     upperCaseLetter: true,
+ *     specialCharacter: true,
+ *     unallowableCharacter: false
+ *   }
+ * }
+ */
+declare function validatePassword(value: string, { level, ignoreCase, special }?: {
+    level?: number | undefined;
+    ignoreCase?: boolean | undefined;
+    special?: string | undefined;
+} | undefined): ValidatePasswordReturn;

package/types/src/waitTime.d.ts

@@ -0,0 +1,20 @@
+export default waitTime;
+/**
+ * 等待时间返回 Promise 。常用于异步方法中延时。
+ *
+ * @static
+ * @alias module:Other.waitTime
+ * @since 4.2.0
+ * @param {number} [time=1000] 延时时间，单位毫秒
+ * @returns {Promise<void>}
+ * @example
+ * const test = async ()=>{
+ *   await waitTime();
+ *   // do something
+ * }
+ *
+ * waitTime(500).then(()=>{
+ *   // do something
+ * })
+ */
+declare function waitTime(time?: number | undefined): Promise<void>;