my-uniapp-tools 3.0.2 → 4.0.1

package/dist/system/index.d.ts

@@ -1,38 +1,51 @@
 /**
- * 系统信息相关工具函数（优化版本）
+ * 系统信息相关工具函数
+ * 核心原则：简单、清晰、零破坏性
  */
-/**
- * 获取窗口信息（优化版本）
- * @param useCache 是否使用缓存，默认true
- * @returns 窗口信息对象，包含窗口尺寸、像素比等信息
- * @description 调用 uni.getWindowInfo() 获取当前设备的窗口相关信息，支持缓存
- */
-export declare const useWindowInfo: (useCache?: boolean) => any;
 /**
  * 平台类型定义
  */
 type PlatformType = "weixin" | "web" | "app" | "alipay" | "h5" | "unknown";
+/**
+ * 顶部区域高度度量
+ * @description
+ * - `statusBarHeight`: 状态栏高度
+ * - `navigationBarHeight`: 导航栏高度（不包含状态栏）
+ * - `totalTopHeight`: statusBarHeight + navigationBarHeight
+ */
+export interface TopBarMetrics {
+    statusBarHeight: number;
+    navigationBarHeight: number;
+    totalTopHeight: number;
+    platform: PlatformType;
+}
+/**
+ * 清除系统缓存（横竖屏切换时调用）
+ */
+export declare const clearSystemCache: () => void;
 /**
  * 获取当前运行平台
  * @returns 平台类型字符串 ('weixin' | 'web' | 'app' | 'alipay' | 'h5' | 'unknown')
- * @description 通过条件编译判断当前代码运行的平台环境，并增加缓存避免重复计算
+ * @description 通过条件编译判断当前代码运行的平台环境
  */
 export declare const getPlatform: () => PlatformType;
+/**
+ * 获取窗口信息
+ * @param useCache 是否使用缓存，默认true
+ * @returns 窗口信息对象，包含窗口尺寸、像素比等信息
+ * @description 调用 uni.getWindowInfo() 获取当前设备的窗口相关信息，支持缓存
+ */
+export declare const useWindowInfo: (useCache?: boolean) => UniNamespace.GetWindowInfoResult | null;
 /**
  * 获取小程序账户信息
  * @returns 小程序账户信息对象，包含appId、版本、环境等信息
  * @description 调用 uni.getAccountInfoSync() 获取当前小程序的账户相关信息
  */
 export declare const getCurrentEnv: () => {
-    appId: string;
-    version: string;
-    envVersion: "develop" | "trial" | "release";
-    accountInfo: UniApp.AccountInfo;
-} | {
     appId: string;
     version: string;
     envVersion: string;
-    accountInfo: null;
+    accountInfo: any;
 };
 /**
  * 检查小程序版本更新
@@ -48,27 +61,39 @@ export declare const onCheckForUpdate: () => void;
  * @returns 状态栏高度（单位：px）
  * @description 获取设备状态栏的高度，用于适配不同设备的状态栏
  */
-export declare const getStatusBarHeight: () => any;
+export declare const getStatusBarHeight: () => number;
 /**
  * 获取菜单按钮边界信息
  * @returns 菜单按钮边界信息对象或null
  * @description 获取小程序右上角菜单按钮的边界信息，仅在小程序平台有效
  */
-export declare const getMenuButtonBoundingClientRect: () => UniApp.GetMenuButtonBoundingClientRectRes | null;
+export declare const getMenuButtonBoundingClientRect: () => UniNamespace.GetMenuButtonBoundingClientRectRes | null;
 /**
- * 获取导航栏高度
+ * 获取导航栏高度（不含状态栏）
  * @returns 导航栏高度（单位：px）
- * @description 获取导航栏的总高度，根据不同平台采用不同的计算方式
+ * @description 获取导航栏的高度，不包含状态栏高度
+ */
+export declare const getNavigationBarHeight: () => number;
+/**
+ * 获取顶部区域高度度量（推荐使用）
+ * @description 返回结构化的顶部区域高度信息，避免重复计算
  */
-export declare const getNavHeight: () => any;
+export declare const getTopBarMetrics: () => TopBarMetrics;
 /**
- * @returns 包含状态栏高度和导航栏高度的配置对象
+ * @deprecated 请使用 getTopBarMetrics() 获取结构化数据，或使用 getStatusBarHeight() + getNavigationBarHeight()
+ * @returns 包含状态栏高度和导航栏总高度的配置对象
  * @description 一次性获取应用所需的状态栏和导航栏高度配置信息
  */
 export declare const getTopNavBarHeight: () => {
-    statusBarHeight: any;
-    navHeight: any;
+    statusBarHeight: number;
+    navHeight: number;
 };
+/**
+ * @deprecated 请使用 getTopBarMetrics().totalTopHeight
+ * @returns 导航栏总高度（包含状态栏，单位：px）
+ * @description 获取导航栏的总高度，包含状态栏高度
+ */
+export declare const getNavHeight: () => number;
 /**
  * 修改页面标题
  * @param title 新的页面标题

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "my-uniapp-tools",
-    "version": "3.0.2",
+    "version": "4.0.1",
     "type": "module",
     "description": "一个功能强大、性能优化的 uni-app 开发工具库，提供剪贴板、本地存储、导航、系统信息等常用功能",
     "main": "dist/my-uniapp-tools.cjs.js",
@@ -37,7 +37,6 @@
         "storage",
         "navigation",
         "system",
-        "performance",
         "typescript",
         "微信小程序",
         "支付宝小程序",
@@ -77,8 +76,5 @@
         "sass-embedded": "^1.89.2",
         "typescript": "^5.8.3",
         "vuepress": "^2.0.0-rc.24"
-    },
-    "directories": {
-        "example": "examples"
     }
 }