ms-types 0.1.23 → 0.1.25

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;
+}