ph-utils 0.9.3 → 0.9.4

package/lib/index.d.ts

@@ -1,9 +1,9 @@
 /**
- * 验证字符串是否为空
- * @param str               待验证的字符串
- * @param ignoreWhitespace  是否忽略空格(包括空白字符串以及[\r\t\n]之类的制表符)，默认为true
+ * 验证参数是否为空
+ * @param str               待验证的参数
+ * @param ignoreWhitespace  如果是字符串是否忽略空格(包括空白字符串以及[\r\t\n]之类的制表符)，默认为true
  */
-export declare function isBlank(str?: string | null, ignoreWhitespace?: boolean): boolean;
+export declare function isBlank(str?: any, ignoreWhitespace?: boolean): boolean;
 /**
  * 屏蔽手机号，中间部分用 * 展示
  * @param mobile 待屏蔽的手机号

package/lib/index.js

@@ -6,15 +6,17 @@ const RANDOM_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz012345
 /** 只包含字母的随机数字符 */
 const NUMBER_RANDOM_CHARTS = "0123456789";
 /**
- * 验证字符串是否为空
- * @param str               待验证的字符串
- * @param ignoreWhitespace  是否忽略空格(包括空白字符串以及[\r\t\n]之类的制表符)，默认为true
+ * 验证参数是否为空
+ * @param str               待验证的参数
+ * @param ignoreWhitespace  如果是字符串是否忽略空格(包括空白字符串以及[\r\t\n]之类的制表符)，默认为true
  */
 export function isBlank(str, ignoreWhitespace = true) {
     if (str == null) {
         return true;
     }
-    return (ignoreWhitespace ? str.trim().length : str.length) === 0;
+    return ((ignoreWhitespace && typeof str === "string"
+        ? str.trim().length
+        : str.length) === 0);
 }
 /**
  * 屏蔽手机号，中间部分用 * 展示

package/lib/theme.d.ts

@@ -4,13 +4,13 @@ export declare function getSystemTheme(): "dark" | "light" | "auto";
  * 初始化主题, 让网页能够适应系统主题, 同时根据缓存的主题切换主题
  * @returns 当前应用的主题
  */
-export declare function initTheme(): Promise<"dark" | "light" | "auto" | undefined>;
+export declare function initTheme(): Promise<"dark" | "light" | "auto">;
 /**
  * 切换主题, 通常用于预览
  * @param theme 切换的主题
  * @returns 切换后的主题
  */
-export declare function toggleTheme(theme?: "light" | "dark" | "auto"): Promise<"dark" | "light" | "auto" | undefined>;
+export declare function toggleTheme(theme?: "light" | "dark" | "auto"): Promise<"dark" | "light" | "auto">;
 /** 获取当前主题 */
 export declare function getTheme(): string;
 /**
@@ -19,7 +19,7 @@ export declare function getTheme(): string;
  * @param cache 是否缓存应用的主题, 让应用下一次启动的时候, 可以应用主题, 默认: true
  * @returns 应用的主题
  */
-export declare function applyTheme(theme?: "light" | "dark" | "auto", cache?: boolean): Promise<"dark" | "light" | "auto" | undefined>;
+export declare function applyTheme(theme?: "light" | "dark" | "auto", cache?: boolean): Promise<"dark" | "light" | "auto">;
 /** 获取当前主题色 */
 export declare function getColorTheme(defaultValue?: string): string | undefined;
 /**

package/lib/theme.js

@@ -37,6 +37,9 @@ export async function initTheme() {
  */
 export async function toggleTheme(theme) {
     const classList = document.documentElement.classList;
+    if (theme == null) {
+        theme = getSystemTheme();
+    }
     if (theme === "light") {
         classList.add("light");
         classList.remove("dark");

package/lib/validator.d.ts

@@ -26,7 +26,20 @@ declare class Validator {
     };
     /**
      * 构造数据验证转换器
+     *
+     * See {@link https://gitee.com/towardly/ph/wikis/utils/validator|Validator文档}.
+     *
      * @param schemas 配置验证转换规则
+     *
+     * @example
+     *
+     * const validator = new Validator([
+     *  { key: 'mobile', rules: ['required', 'mobile'] },
+     *  { key: 'code': rules: /^\d{6}$/, message: '请输入正确的验证码' },
+     *  { key: 'confirmPassword', rules: ['required', 'same:password'] }
+     * ])
+     * // 验证某一个字段
+     * validator.validateKey().then(res => {})
      */
     constructor(schemas: SchemaType[]);
     /**

package/lib/validator.js

@@ -47,7 +47,20 @@ class Validator {
     rules;
     /**
      * 构造数据验证转换器
+     *
+     * See {@link https://gitee.com/towardly/ph/wikis/utils/validator|Validator文档}.
+     *
      * @param schemas 配置验证转换规则
+     *
+     * @example
+     *
+     * const validator = new Validator([
+     *  { key: 'mobile', rules: ['required', 'mobile'] },
+     *  { key: 'code': rules: /^\d{6}$/, message: '请输入正确的验证码' },
+     *  { key: 'confirmPassword', rules: ['required', 'same:password'] }
+     * ])
+     * // 验证某一个字段
+     * validator.validateKey().then(res => {})
      */
     constructor(schemas) {
         let parsedRules = {};

package/package.json

@@ -64,7 +64,7 @@
     },
     "./*": "./lib/*"
   },
-  "version": "0.9.3",
+  "version": "0.9.4",
   "type": "module",
   "repository": {
     "type": "git",