ms-types 0.4.8 → 0.4.10

package/types/device.d.ts

@@ -1,117 +1,117 @@
-/**
- * 设备模块 包含获取设备信息、设备操作等功能
- */
-declare namespace device {
-  /**
-   * 获取电池信息
-   * @returns 电池信息
-   * @example device.getBatteryInfo()
-   */
-  function getBatteryInfo(): {
-    /**
-     * 电池电量
-     */
-    level: number;
-    /**
-     * 是否充电
-     */
-    isCharging: boolean;
-  };
-  /**
-   * 获取设备ID
-   * @returns 设备ID
-   * @example device.getDeviceID()
-   */
-  function getDeviceID(): string;
-  /**
-   * 获取服务器设备ID
-   * @returns 服务器设备ID
-   * @example device.getServerDeviceId()
-   */
-  function getServerDeviceId(): string;
-  /**
-   * 获取ECID
-   * @returns ECID
-   * @example device.getECID()
-   */
-  function getECID(): string;
-  /**
-   * 获取UDID
-   * @returns UDID
-   * @example device.getUDID()
-   */
-  function getUDID(): string;
-  /**
-   * 获取设备名称
-   * @returns 设备名称
-   * @example device.getDeviceName()
-   */
-  function getDeviceName(): string;
-  /**
-   * 获取设备型号
-   * @returns 设备型号
-   * @example device.getDeviceModel()
-   */
-  function getDeviceModel(): string;
-  /**
-   * 获取屏幕宽高
-   * @returns 获取屏幕宽高缩放后的，实际宽高，请使用`getScreenRealSize()`获取未缩放的宽高
-   * @example device.getScreenSize()
-   */
-  function getScreenSize(): {
-    /**
-     * 屏幕宽度
-     */
-    width: number;
-    /**
-     * 屏幕高度
-     */
-    height: number;
-  };
-  /**
-   * 获取屏幕实际大小
-   * @returns 屏幕实际大小
-   * @example device.getScreenRealSize()
-   */
-  function getScreenRealSize(): {
-    /**
-     * 屏幕宽度
-     */
-    width: number;
-    /**
-     * 屏幕高度
-     */
-    height: number;
-  };
-  /**
-   * 获取屏幕缩放比例
-   * @returns 屏幕缩放比例
-   * @example device.getScreenScale()
-   */
-  function getScreenScale(): number;
-  /**
-   * 获取屏幕方向 PORTRAIT 竖屏 LANDSCAPE 横屏
-   * @returns 设备方向
-   * @example device.getOrientation()
-   */
-  function getOrientation(): "PORTRAIT" | "LANDSCAPE";
-  /**
-   * 获取系统版本 例如 16.7.11
-   * @returns 系统版本
-   * @example device.getOSVersion()
-   */
-  function getOSVersion(): string;
-  /**
-   * 获取局域网IP 例如 192.168.1.100
-   * @returns 局域网IP
-   * @example device.getLanIp()
-   */
-  function getLanIp(): string;
-  /**
-   * 振动
-   * @param duration 持续时间 单位毫秒
-   * @param intensity 强度 0.0-1.0
-   * @example device.vibrate(1000, 0.5)
-   */
-  function vibrate(duration: number, intensity: number): void;
-}
+/**
+ * 设备模块 包含获取设备信息、设备操作等功能
+ */
+declare namespace device {
+  /**
+   * 获取电池信息
+   * @returns 电池信息
+   * @example device.getBatteryInfo()
+   */
+  function getBatteryInfo(): {
+    /**
+     * 电池电量
+     */
+    level: number;
+    /**
+     * 是否充电
+     */
+    isCharging: boolean;
+  };
+  /**
+   * 获取设备ID
+   * @returns 设备ID
+   * @example device.getDeviceID()
+   */
+  function getDeviceID(): string;
+  /**
+   * 获取服务器设备ID
+   * @returns 服务器设备ID
+   * @example device.getServerDeviceId()
+   */
+  function getServerDeviceId(): string;
+  /**
+   * 获取ECID
+   * @returns ECID
+   * @example device.getECID()
+   */
+  function getECID(): string;
+  /**
+   * 获取UDID
+   * @returns UDID
+   * @example device.getUDID()
+   */
+  function getUDID(): string;
+  /**
+   * 获取设备名称
+   * @returns 设备名称
+   * @example device.getDeviceName()
+   */
+  function getDeviceName(): string;
+  /**
+   * 获取设备型号
+   * @returns 设备型号
+   * @example device.getDeviceModel()
+   */
+  function getDeviceModel(): string;
+  /**
+   * 获取屏幕宽高
+   * @returns 获取屏幕宽高缩放后的，实际宽高，请使用`getScreenRealSize()`获取未缩放的宽高
+   * @example device.getScreenSize()
+   */
+  function getScreenSize(): {
+    /**
+     * 屏幕宽度
+     */
+    width: number;
+    /**
+     * 屏幕高度
+     */
+    height: number;
+  };
+  /**
+   * 获取屏幕实际大小
+   * @returns 屏幕实际大小
+   * @example device.getScreenRealSize()
+   */
+  function getScreenRealSize(): {
+    /**
+     * 屏幕宽度
+     */
+    width: number;
+    /**
+     * 屏幕高度
+     */
+    height: number;
+  };
+  /**
+   * 获取屏幕缩放比例
+   * @returns 屏幕缩放比例
+   * @example device.getScreenScale()
+   */
+  function getScreenScale(): number;
+  /**
+   * 获取屏幕方向 PORTRAIT 竖屏 LANDSCAPE 横屏
+   * @returns 设备方向
+   * @example device.getOrientation()
+   */
+  function getOrientation(): "PORTRAIT" | "LANDSCAPE";
+  /**
+   * 获取系统版本 例如 16.7.11
+   * @returns 系统版本
+   * @example device.getOSVersion()
+   */
+  function getOSVersion(): string;
+  /**
+   * 获取局域网IP 例如 192.168.1.100
+   * @returns 局域网IP
+   * @example device.getLanIp()
+   */
+  function getLanIp(): string;
+  /**
+   * 振动
+   * @param duration 持续时间 单位毫秒
+   * @param intensity 强度 0.0-1.0
+   * @example device.vibrate(1000, 0.5)
+   */
+  function vibrate(duration: number, intensity: number): void;
+}

package/types/global.d.ts

@@ -1,220 +1,230 @@
-/**
- * 是否是调试模式
- */
-declare const __debug__: boolean;
-/**
- * 平台标识
- */
-declare const __platform__: "ios" | "android";
-/**
-/**
- * 应用版本
- */
-declare const __appVersion__: string;
-/**
- * 应用构建号
- */
-declare const __appBuildNumber__: number;
-/**
- * 应用名称
- */
-declare const __appName__: string;
-/**
- * 应用 bundleId
- */
-declare const __bundleId__: string;
-/**
- * 当前线程名称
- */
-declare const __threadName__: string;
-/**
- * 脚本信息
- */
-declare const __package__: {
-  /**
-   * 应用名称
-   */
-  name: string;
-  /**
-   * 应用包名
-   */
-  package: string;
-  /**
-   * 应用版本
-   */
-  appVersion: string;
-  /**
-   * 应用 Id
-   */
-  appId: string;
-  /**
-   * 应用更新参数
-   */
-  update: {
-    /**
-     * 应用更新地址
-     */
-    url: string;
-    /**
-     * 应用更新超时时间
-     */
-    timeout: number;
-  };
-  [key: string]: any;
-};
-
-declare const sharedState: {
-  /**
-   * 设置共享状态
-   * @param key 状态键
-   * @param value 状态值
-   */
-  set: (key: string, value: any) => void;
-  /**
-   * 获取共享状态
-   * @param key 状态键
-   * @returns 状态值
-   */
-  get: (key: string) => any;
-  /**
-   * 批量操作共享状态
-   * @param block 批量操作代码块
-   */
-  withBatch: (block: () => void) => void;
-  /**
-   * 清除所有共享状态
-   */
-  clear: () => void;
-};
-
-/**
- * 设置停止回调（仅主线程调用）
- * @param callback 停止回调
- * @description 脚本执行完成或异常停止时调用，exit 退出不会触发
- * @example
- * setStopCallback(() => {
- *   logi("脚本执行完成");
- * });
- */
-declare function setStopCallback(callback: () => void): void;
-
-/**
- * 设置异常停止回调（仅主线程调用）
- * @param callback 异常停止回调
- * @description 脚本执行异常停止时调用
- * @example
- * setExceptionCallback(() => {
- *   loge("脚本执行异常");
- * });
- */
-declare function setExceptionCallback(callback: () => void): void;
-
-/**
- * 重启脚本（仅主线程调用）
- * @param delay 延迟时间 毫秒
- * @description 重启脚本会延迟指定时间后再重启，不要低于 2000 毫秒
- * @example
- * setExceptionCallback(() => {
- *   restartScript(2000);
- * });
- */
-declare function restartScript(delay: number): void;
-
-/**
- * 线程睡眠
- * @param ms 毫秒
- * @description 线程睡眠会阻塞当前线程，等待指定时间后继续执行
- * @example
- * sleep(1000);
- */
-declare function sleep(ms: number): void | Promise<void>;
-
-/**
- * 退出脚本
- * @param exitAll 是否退出所有线程 true 退出所有 false 退出当前线程，不传默认 false
- * @description 退出脚本会终止所有线程的执行
- * @example
- * exit();
- */
-declare function exit(exitAll?: boolean): void;
-
-/**
- * 获取当前时间戳
- * @returns 时间戳
- * @example
- * const timestamp = time();
- */
-declare function time(): number;
-
-/**
- * 把 app 切换到前台 utils.takeMeToFront 的别名
- * @returns 是否成功切换到前台
- * @see utils.takeMeToFront
- * @description 把 app 切换到前台
- * @example
- * takeMeToFront();
- */
-declare function takeMeToFront(): boolean;
-
-/**
- * 打印调试日志 - 输出调试级别的日志
- * 用于详细的程序执行信息、变量值和状态信息、函数调用跟踪
- * @param args 日志消息内容
- * @see logger.debug
- * @example
- * logd("程序开始执行");
- * logd(`当前用户: ${username}`);
- */
-declare function logd(...args: any[]): void;
-
-/**
- * 打印信息日志 - 输出信息级别的日志
- * 用于程序正常运行信息、重要操作的确认、状态变更通知
- * @param args 日志消息内容
- * @see logger.info
- * @example
- * logi("应用程序启动成功");
- * logi("用户登录成功");
- */
-declare function logi(...args: any[]): void;
-declare function println(...args: any[]): void;
-
-/**
- * 打印警告日志 - 输出警告级别的日志
- * 用于潜在的问题、不推荐的操作、性能警告、兼容性问题
- * @param args 日志消息内容
- * @see logger.warn
- * @example
- * logw("电池电量低于 20%");
- * logw("网络连接不稳定");
- */
-declare function logw(...args: any[]): void;
-
-/**
- * 打印错误日志 - 输出错误级别的日志
- * 用于程序错误和异常、操作失败、系统错误、致命问题
- * @param args 日志消息内容
- * @see logger.error
- * @example
- * loge("网络请求失败");
- * loge("文件读取错误");
- */
-declare function loge(...args: any[]): void;
-
-/**
- * 加载 dex 文件 (仅安卓可用)
- * @param path dex 文件路径
- * @description 加载 dex 文件到内存中
- * @example
- * loadDex("test.dex");
- */
-declare function loadDex(path: string): void;
-
-/**
- * 加载 apk 文件 (仅安卓可用)
- * @param path apk 文件路径
- * @description 加载 apk 文件到内存中
- * @example
- * loadApk("test.apk");
- */
-declare function loadApk(path: string): void;
+/**
+ * 是否是调试模式
+ */
+declare const __debug__: boolean;
+/**
+ * 平台标识
+ */
+declare const __platform__: "ios" | "android";
+/**
+/**
+ * 应用版本
+ */
+declare const __appVersion__: string;
+/**
+ * 应用构建号
+ */
+declare const __appBuildNumber__: number;
+/**
+ * 应用名称
+ */
+declare const __appName__: string;
+/**
+ * 应用 bundleId
+ */
+declare const __bundleId__: string;
+/**
+ * 当前线程名称
+ */
+declare const __threadName__: string;
+/**
+ * 脚本信息
+ */
+declare const __package__: {
+  /**
+   * 应用名称
+   */
+  name: string;
+  /**
+   * 应用包名
+   */
+  package: string;
+  /**
+   * 应用版本
+   */
+  appVersion: string;
+  /**
+   * 应用 Id
+   */
+  appId: string;
+  /**
+   * 应用更新参数
+   */
+  update: {
+    /**
+     * 应用更新地址
+     */
+    url: string;
+    /**
+     * 应用更新超时时间
+     */
+    timeout: number;
+  };
+  [key: string]: any;
+};
+
+declare const sharedState: {
+  /**
+   * 设置共享状态
+   * @param key 状态键
+   * @param value 状态值
+   */
+  set: (key: string, value: any) => void;
+  /**
+   * 获取共享状态
+   * @param key 状态键
+   * @returns 状态值
+   */
+  get: (key: string) => any;
+  /**
+   * 批量操作共享状态
+   * @param block 批量操作代码块
+   */
+  withBatch: (block: () => void) => void;
+  /**
+   * 清除所有共享状态
+   */
+  clear: () => void;
+};
+
+/**
+ * 设置停止回调（仅主线程调用）
+ * @param callback 停止回调
+ * @description 脚本执行完成或异常停止时调用，exit 退出不会触发
+ * @example
+ * setStopCallback(() => {
+ *   logi("脚本执行完成");
+ * });
+ */
+declare function setStopCallback(callback: () => void): void;
+
+/**
+ * 设置异常停止回调（仅主线程调用）
+ * @param callback 异常停止回调
+ * @description 脚本执行异常停止时调用
+ * @example
+ * setExceptionCallback(() => {
+ *   loge("脚本执行异常");
+ * });
+ */
+declare function setExceptionCallback(callback: () => void): void;
+
+/**
+ * 重启脚本（仅主线程调用）
+ * @param delay 延迟时间 毫秒
+ * @description 重启脚本会延迟指定时间后再重启，不要低于 2000 毫秒
+ * @example
+ * setExceptionCallback(() => {
+ *   restartScript(2000);
+ * });
+ */
+declare function restartScript(delay: number): void;
+
+/**
+ * 线程睡眠
+ * @param ms 毫秒
+ * @description 线程睡眠会阻塞当前线程，等待指定时间后继续执行
+ * @example
+ * sleep(1000);
+ */
+declare function sleep(ms: number): void | Promise<void>;
+
+/**
+ * 退出脚本
+ * @param exitAll 是否退出所有线程 true 退出所有 false 退出当前线程，不传默认 false
+ * @description 退出脚本会终止所有线程的执行
+ * @example
+ * exit();
+ */
+declare function exit(exitAll?: boolean): void;
+
+/**
+ * 获取当前时间戳
+ * @returns 时间戳
+ * @example
+ * const timestamp = time();
+ */
+declare function time(): number;
+
+/**
+ * 把 app 切换到前台 utils.takeMeToFront 的别名
+ * @returns 是否成功切换到前台
+ * @see utils.takeMeToFront
+ * @description 把 app 切换到前台
+ * @example
+ * takeMeToFront();
+ */
+declare function takeMeToFront(): boolean;
+
+/**
+ * 打印调试日志 - 输出调试级别的日志
+ * 用于详细的程序执行信息、变量值和状态信息、函数调用跟踪
+ * @param args 日志消息内容
+ * @see logger.debug
+ * @example
+ * logd("程序开始执行");
+ * logd(`当前用户: ${username}`);
+ */
+declare function logd(...args: any[]): void;
+
+/**
+ * 打印信息日志 - 输出信息级别的日志
+ * 用于程序正常运行信息、重要操作的确认、状态变更通知
+ * @param args 日志消息内容
+ * @see logger.info
+ * @example
+ * logi("应用程序启动成功");
+ * logi("用户登录成功");
+ */
+declare function logi(...args: any[]): void;
+declare function println(...args: any[]): void;
+
+/**
+ * 打印警告日志 - 输出警告级别的日志
+ * 用于潜在的问题、不推荐的操作、性能警告、兼容性问题
+ * @param args 日志消息内容
+ * @see logger.warn
+ * @example
+ * logw("电池电量低于 20%");
+ * logw("网络连接不稳定");
+ */
+declare function logw(...args: any[]): void;
+
+/**
+ * 打印错误日志 - 输出错误级别的日志
+ * 用于程序错误和异常、操作失败、系统错误、致命问题
+ * @param args 日志消息内容
+ * @see logger.error
+ * @example
+ * loge("网络请求失败");
+ * loge("文件读取错误");
+ */
+declare function loge(...args: any[]): void;
+
+/**
+ * 查找类 (仅安卓可用)
+ * @param className 类名
+ * @returns 类对象
+ * @description 查找类对象
+ * @example
+ * const clazz = importClass("com.example.TestClass");
+ */
+declare function importClass(className: string): any;
+
+/**
+ * 加载 dex 文件 (仅安卓可用)
+ * @param path dex 文件路径 支持apk文件
+ * @description 加载 dex 文件到内存中
+ * @example
+ * loadDex("test.dex");
+ */
+declare function loadDex(path: string): void;
+
+/**
+ * 获取当前上下文 (仅安卓可用)
+ * @returns 当前上下文
+ * @description 获取当前上下文
+ * @example
+ * const context = getContext();
+ */
+declare function getContext(): any;