ms-types 0.0.72 → 0.0.74

package/types/global.d.ts

@@ -1,171 +1,171 @@
-/**
- * 是否是调试模式
- */
-declare const __debug__: boolean;
-/**
- * 是否应该退出应用
- */
-declare const __shouldExit__: boolean;
-/**
- * 应用版本
- */
-declare const __appVersion__: string;
-/**
- * 应用构建号
- */
-declare const __appBuildNumber__: string;
-/**
- * 应用名称
- */
-declare const __appName__: string;
-/**
- * 应用 bundleId
- */
-declare const __bundleId__: string;
-/**
- * 当前线程名称
- */
-declare const __threadName__: string;
-/**
- * 脚本信息
- */
-declare const __package__: {
-  /**
-   * 应用名称
-   */
-  name: string;
-  /**
-   * 应用版本
-   */
-  appVersion: string;
-  /**
-   * 应用 Id
-   */
-  appId: string;
-  /**
-   * 应用更新参数
-   */
-  update: {
-    /**
-     * 应用更新地址
-     */
-    url: string;
-    /**
-     * 应用更新超时时间
-     */
-    timeout: number;
-  };
-  [key: string]: any;
-};
-
-/**
- * 设置停止回调（仅主线程调用）
- * @param callback 停止回调
- * @description 脚本执行完成或异常停止时调用，exit 退出不会触发
- * @example
- * setStopCallback(() => {
- *   logi("脚本执行完成");
- * });
- */
-declare function setStopCallback(callback: Function): 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;
-
-/**
- * 退出脚本
- * @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 的别名
- * @see utils.takeMeToFront
- * @description 把 app 切换到前台
- * @example
- * takeMeToFront();
- */
-declare function takeMeToFront(): void;
-
-/**
- * 打印调试日志 - 输出调试级别的日志
- * 用于详细的程序执行信息、变量值和状态信息、函数调用跟踪
- * @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;
-
-/**
- * 打印警告日志 - 输出警告级别的日志
- * 用于潜在的问题、不推荐的操作、性能警告、兼容性问题
- * @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;
+/**
+ * 是否是调试模式
+ */
+declare const __debug__: boolean;
+/**
+ * 是否应该退出应用
+ */
+declare const __shouldExit__: boolean;
+/**
+ * 应用版本
+ */
+declare const __appVersion__: string;
+/**
+ * 应用构建号
+ */
+declare const __appBuildNumber__: string;
+/**
+ * 应用名称
+ */
+declare const __appName__: string;
+/**
+ * 应用 bundleId
+ */
+declare const __bundleId__: string;
+/**
+ * 当前线程名称
+ */
+declare const __threadName__: string;
+/**
+ * 脚本信息
+ */
+declare const __package__: {
+  /**
+   * 应用名称
+   */
+  name: string;
+  /**
+   * 应用版本
+   */
+  appVersion: string;
+  /**
+   * 应用 Id
+   */
+  appId: string;
+  /**
+   * 应用更新参数
+   */
+  update: {
+    /**
+     * 应用更新地址
+     */
+    url: string;
+    /**
+     * 应用更新超时时间
+     */
+    timeout: number;
+  };
+  [key: string]: any;
+};
+
+/**
+ * 设置停止回调（仅主线程调用）
+ * @param callback 停止回调
+ * @description 脚本执行完成或异常停止时调用，exit 退出不会触发
+ * @example
+ * setStopCallback(() => {
+ *   logi("脚本执行完成");
+ * });
+ */
+declare function setStopCallback(callback: Function): 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;
+
+/**
+ * 退出脚本
+ * @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 的别名
+ * @see utils.takeMeToFront
+ * @description 把 app 切换到前台
+ * @example
+ * takeMeToFront();
+ */
+declare function takeMeToFront(): void;
+
+/**
+ * 打印调试日志 - 输出调试级别的日志
+ * 用于详细的程序执行信息、变量值和状态信息、函数调用跟踪
+ * @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;
+
+/**
+ * 打印警告日志 - 输出警告级别的日志
+ * 用于潜在的问题、不推荐的操作、性能警告、兼容性问题
+ * @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;

package/types/hotUpdate.d.ts

@@ -1,104 +1,104 @@
-/**
- * 热更新模块类型定义
- * 提供应用热更新功能，包括检查更新、下载更新包、MD5校验等
- */
-declare namespace hotUpdate {
-  /**
-   * 热更新检查结果
-   */
-  interface HotUpdateResult {
-    /** 是否需要更新 */
-    needUpdate: boolean;
-    /** 错误信息（当检查失败时） */
-    error?: string;
-    /** 服务器返回的更新数据（当 needUpdate 为 true 时） */
-    data?: HotUpdateResponse;
-  }
-
-  /**
-   * 热更新服务器响应数据结构
-   */
-  interface HotUpdateResponse {
-    /** 新包的下载地址 */
-    download_url: string;
-    /** 新包的版本号 */
-    version: number;
-    /** 下载msbundle文件超时时间（秒） */
-    download_timeout: number;
-    /** 是否用对话框的形式展示 */
-    dialog: boolean;
-    /** 对话框中要显示的消息 */
-    msg: string;
-    /** 对话框模式下是否强制更新 */
-    force: boolean;
-    /** 更新包文件的MD5值，用于校验文件完整性 */
-    md5?: string;
-  }
-
-  /**
-   * 热更新配置选项
-   */
-  interface HotUpdateOptions {
-    /** 检查更新的服务器URL，未提供时从 package.json 的 update.url 读取 */
-    url?: string;
-    /** 当前版本号，未提供时从 package.json 的 appVersion 读取 */
-    version?: number;
-    /** 超时时间（毫秒），未提供时从 package.json 的 update.timeout 读取，默认10000毫秒 */
-    timeout?: number;
-  }
-  /**
-   * 检查更新（同步调用）
-   * @param options 更新配置选项（可选，不传则从package.json读取配置）
-   * @returns 检查结果
-   *
-   * @example
-   * // 检查更新（使用默认配置）
-   * const result = hotUpdate.checkUpdate();
-   *
-   * // 或者传入自定义配置
-   * const result2 = hotUpdate.checkUpdate({
-   *   url: 'https://api.example.com/check-update'
-   * });
-   *
-   * if (result.needUpdate) {
-   *   logi('发现新版本');
-   *   // 手动决定是否更新
-   *   const installResult = hotUpdate.downloadAndInstall();
-   *   logi('安装结果:', installResult);
-   * } else {
-   *   loge('检查更新失败:', result.error);
-   * }
-   */
-  function checkUpdate(options?: HotUpdateOptions): HotUpdateResult;
-
-  /**
-   * 手动下载并安装更新, 执行成功后会自动重启脚本
-   * @returns 安装结果
-   * @example
-   * ```javascript
-   * const checkResult = hotUpdate.checkUpdate();
-   * if (checkResult.needUpdate) {
-   *   const installResult = hotUpdate.downloadAndInstall();
-   *   if (installResult.updated) {
-   *     logi('更新安装成功');
-   *   } else {
-   *     loge('更新安装失败:', installResult.error);
-   *   }
-   * }
-   * ```
-   */
-  function downloadAndInstall(): {
-    updated: boolean;
-    error?: string;
-  };
-
-  /**
-   * 获取当前应用版本号
-   * 从 package.json 文件中读取 appVersion 字段并返回数字类型版本号
-   * @returns {number} 当前版本号，如果获取失败则返回 0
-   * @example
-   * const version = hotUpdate.getCurrentVersion();
-   * logi('当前版本:', version); // 输出: 当前版本: 123
-   */
-  function getCurrentVersion(): number;
-}
+/**
+ * 热更新模块类型定义
+ * 提供应用热更新功能，包括检查更新、下载更新包、MD5校验等
+ */
+declare namespace hotUpdate {
+  /**
+   * 热更新检查结果
+   */
+  interface HotUpdateResult {
+    /** 是否需要更新 */
+    needUpdate: boolean;
+    /** 错误信息（当检查失败时） */
+    error?: string;
+    /** 服务器返回的更新数据（当 needUpdate 为 true 时） */
+    data?: HotUpdateResponse;
+  }
+
+  /**
+   * 热更新服务器响应数据结构
+   */
+  interface HotUpdateResponse {
+    /** 新包的下载地址 */
+    download_url: string;
+    /** 新包的版本号 */
+    version: number;
+    /** 下载msbundle文件超时时间（秒） */
+    download_timeout: number;
+    /** 是否用对话框的形式展示 */
+    dialog: boolean;
+    /** 对话框中要显示的消息 */
+    msg: string;
+    /** 对话框模式下是否强制更新 */
+    force: boolean;
+    /** 更新包文件的MD5值，用于校验文件完整性 */
+    md5?: string;
+  }
+
+  /**
+   * 热更新配置选项
+   */
+  interface HotUpdateOptions {
+    /** 检查更新的服务器URL，未提供时从 package.json 的 update.url 读取 */
+    url?: string;
+    /** 当前版本号，未提供时从 package.json 的 appVersion 读取 */
+    version?: number;
+    /** 超时时间（毫秒），未提供时从 package.json 的 update.timeout 读取，默认10000毫秒 */
+    timeout?: number;
+  }
+  /**
+   * 检查更新（同步调用）
+   * @param options 更新配置选项（可选，不传则从package.json读取配置）
+   * @returns 检查结果
+   *
+   * @example
+   * // 检查更新（使用默认配置）
+   * const result = hotUpdate.checkUpdate();
+   *
+   * // 或者传入自定义配置
+   * const result2 = hotUpdate.checkUpdate({
+   *   url: 'https://api.example.com/check-update'
+   * });
+   *
+   * if (result.needUpdate) {
+   *   logi('发现新版本');
+   *   // 手动决定是否更新
+   *   const installResult = hotUpdate.downloadAndInstall();
+   *   logi('安装结果:', installResult);
+   * } else {
+   *   loge('检查更新失败:', result.error);
+   * }
+   */
+  function checkUpdate(options?: HotUpdateOptions): HotUpdateResult;
+
+  /**
+   * 手动下载并安装更新, 执行成功后会自动重启脚本
+   * @returns 安装结果
+   * @example
+   * ```javascript
+   * const checkResult = hotUpdate.checkUpdate();
+   * if (checkResult.needUpdate) {
+   *   const installResult = hotUpdate.downloadAndInstall();
+   *   if (installResult.updated) {
+   *     logi('更新安装成功');
+   *   } else {
+   *     loge('更新安装失败:', installResult.error);
+   *   }
+   * }
+   * ```
+   */
+  function downloadAndInstall(): {
+    updated: boolean;
+    error?: string;
+  };
+
+  /**
+   * 获取当前应用版本号
+   * 从 package.json 文件中读取 appVersion 字段并返回数字类型版本号
+   * @returns {number} 当前版本号，如果获取失败则返回 0
+   * @example
+   * const version = hotUpdate.getCurrentVersion();
+   * logi('当前版本:', version); // 输出: 当前版本: 123
+   */
+  function getCurrentVersion(): number;
+}