ms-types 0.1.22 → 0.1.25

package/types/global.d.ts

@@ -1,181 +1,185 @@
-/**
- * 是否是调试模式
- */
-declare const __debug__: boolean;
-/**
- * 是否应该退出应用
- */
-declare const __shouldExit__: boolean;
-/**
- * 应用版本
- */
-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;
-  /**
-   * 应用版本
-   */
-  appVersion: string;
-  /**
-   * 应用 Id
-   */
-  appId: string;
-  /**
-   * 应用更新参数
-   */
-  update: {
-    /**
-     * 应用更新地址
-     */
-    url: string;
-    /**
-     * 应用更新超时时间
-     */
-    timeout: number;
-  };
-  [key: string]: any;
-};
-
-/**
- * 设置异步模式 设置为异步模式后，方法定义的返回值有 `Promise` 的 `API` 方法都会返回 Promise 异步执行
- * 必须写在 main 方法第一行
- * @param asyncMode 是否异步模式
- * @description 设置是否开启异步模式，默认 false
- * @example
- * setAsyncMode(true);
- */
-declare function setAsyncMode(asyncMode: boolean): 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 的别名
- * @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__: 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;
+};
+
+/**
+ * 设置异步模式 设置为异步模式后，方法定义的返回值有 `Promise` 的 `API` 方法都会返回 Promise 异步执行
+ * 必须写在 main 方法第一行
+ * @param asyncMode 是否异步模式
+ * @description 设置是否开启异步模式，默认 false
+ * @example
+ * setAsyncMode(true);
+ */
+declare function setAsyncMode(asyncMode: boolean): 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 的别名
+ * @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;