ms-types 0.0.20 → 0.0.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ms-types",
-  "version": "0.0.20",
+  "version": "0.0.22",
   "type": "module",
   "license": "MIT",
   "publishConfig": {

package/types/device.d.ts

@@ -56,6 +56,21 @@ declare namespace device {
      */
     height: number;
   };
+  /**
+   * 获取屏幕实际大小
+   * @returns 屏幕实际大小
+   * @example device.getScreenRealSize()
+   */
+  function getScreenRealSize(): {
+    /**
+     * 屏幕宽度
+     */
+    width: number;
+    /**
+     * 屏幕高度
+     */
+    height: number;
+  };
   /**
    * 获取屏幕缩放比例
    * @returns 屏幕缩放比例

package/types/global.d.ts

@@ -58,67 +58,106 @@ declare const __package__: {
   [key: string]: any;
 };
 
+/**
+ * 设置停止回调（仅主线程调用）
+ * @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;
 /**
  * 退出应用
+ * @description 退出应用会终止所有线程的执行
+ * @example
+ * exit();
  */
 declare function exit(): 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 delay 延迟时间 毫秒
- */
-declare function restartScript(delay: number): void;
 /**
  * 日志调试 - 输出调试级别的日志
  * 用于详细的程序执行信息、变量值和状态信息、函数调用跟踪
- * @param message 日志消息内容
+ * @param args 日志消息内容
  * @see logger.debug
  * @example
  * logd("程序开始执行");
  * logd(`当前用户: ${username}`);
  */
-declare function logd(message: string): void;
+declare function logd(...args: any[]): void;
 /**
  * 日志信息 - 输出信息级别的日志
  * 用于程序正常运行信息、重要操作的确认、状态变更通知
- * @param message 日志消息内容
+ * @param args 日志消息内容
  * @see logger.info
  * @example
  * logi("应用程序启动成功");
  * logi("用户登录成功");
  */
-declare function logi(message: string): void;
+declare function logi(...args: any[]): void;
 /**
  * 日志警告 - 输出警告级别的日志
  * 用于潜在的问题、不推荐的操作、性能警告、兼容性问题
- * @param message 日志消息内容
+ * @param args 日志消息内容
  * @see logger.warn
  * @example
  * logw("电池电量低于 20%");
  * logw("网络连接不稳定");
  */
-declare function logw(message: string): void;
+declare function logw(...args: any[]): void;
 /**
  * 日志错误 - 输出错误级别的日志
  * 用于程序错误和异常、操作失败、系统错误、致命问题
- * @param message 日志消息内容
+ * @param args 日志消息内容
  * @see logger.error
  * @example
  * loge("网络请求失败");
  * loge("文件读取错误");
  */
-declare function loge(message: string): void;
+declare function loge(...args: any[]): void;

package/types/index.d.ts

@@ -13,6 +13,7 @@
 /// <reference path="media.d.ts" />
 /// <reference path="mysql.d.ts" />
 /// <reference path="paddleOcr.d.ts" />
+/// <reference path="pip.d.ts" />
 /// <reference path="system.d.ts" />
 /// <reference path="thread.d.ts" />
 /// <reference path="tomatoOcr.d.ts" />

package/types/logger.d.ts

@@ -26,30 +26,31 @@ declare namespace logger {
   function resetLogFile(): void;
   /**
    * 调试日志
-   * @param log 日志内容
+   * @param args 日志内容
    * @example
    * logger.debug("调试日志");
    */
-  function debug(log: string): void;
+  function debug(...args: any[]): void;
+
   /**
    * 信息日志
-   * @param log 日志内容
+   * @param args 日志内容
    * @example
    * logger.info("信息日志");
    */
-  function info(log: string): void;
+  function info(...args: any[]): void;
   /**
    * 警告日志
-   * @param log 日志内容
+   * @param args 日志内容
    * @example
    * logger.warn("警告日志");
    */
-  function warn(log: string): void;
+  function warn(...args: any[]): void;
   /**
    * 错误日志
-   * @param log 日志内容
+   * @param args 日志内容
    * @example
    * logger.error("错误日志");
    */
-  function error(log: string): void;
+  function error(...args: any[]): void;
 }

package/types/pip.d.ts

@@ -0,0 +1,45 @@
+declare namespace pip {
+  interface LogViewParams {
+    /**
+     * 悬浮窗宽度，不能小于 100
+     */
+    width: number;
+    /**
+     * 悬浮窗高度，不能小于 100
+     */
+    height: number;
+    /**
+     * 日志的字体大小
+     */
+    textSize: number;
+    /**
+     * 日志的文字颜色，格式如 #FFFFFF
+     */
+    textColor: string;
+    /**
+     * 日志的背景颜色，格式如 #000000
+     */
+    backgroundColor: string;
+  }
+  /**
+   * 设置悬浮窗日志窗口的显示参数[显示日志窗口之前调用才会生效]
+   * @param params 包含显示参数的字典
+   */
+  function setLogViewParams(params: LogViewParams): void;
+  /**
+   * 显示日志窗口[App 必须在前台才可调用]
+   * 必须iOS设备支持悬浮窗功能，并且开启悬浮窗
+   * @returns true代表成功，false代表失败
+   */
+  function showLogWindow(): boolean;
+  /**
+   * 关闭日志窗口[App 必须在前台才可调用]
+   * @returns true代表成功，false代表失败
+   */
+  function closeLogWindow(): boolean;
+  /**
+   * 设置是否允许悬浮窗控制脚本启停
+   * @param ctrl true代表允许，false代表不允许
+   */
+  function setPipCtrlScript(ctrl: boolean): void;
+}