ms-types 0.0.11 → 0.0.13

package/types/thread.d.ts

@@ -1,9 +1,5 @@
 /**
- * 当前线程名称
- */
-declare let __threadName__: string;
-/**
- * 线程相关函数
+ * 线程模块 包含线程操作、线程回调等功能
  */
 declare namespace thread {
   /**
@@ -11,25 +7,59 @@ declare namespace thread {
    * @param threadJsFile 线程js文件路径
    * @param callbackName 回调函数名称
    * @param callbackFunc 回调函数
-   * @returns 线程id
+   * @returns 线程名称
+   * @example
+   * thread.execCodeAsync("thread.js", "callback", (data) => {
+   *   console.log(data)
+   *   return "1111"
+   * })
+   *
+   * thread.js
+   * while (!__shouldExit__) {
+   *   // 通知主线程并传递数据
+   *   const data = thread.invokeCallback("callback", "hello world")
+   *   // 主线程返回数据
+   *   console.log(data)
+   *   sleep(1000)
+   * }
    */
   function execCodeAsync(
     threadJsFile: string,
     callbackName: string,
-    callbackFunc: (data?: any) => void
+    callbackFunc: (data?: any) => any
   ): String | null;
   /**
    * 调用线程回调函数
-   * @param name 线程名称
+   * @param name 回调函数名称
    * @param data 回调数据
+   * @returns 回调返回值
+   * @example
+   * const data = thread.invokeCallback("callback", "hello world")
+   * console.log(data)
    */
-  function invokeCallback(name: string, data?: any): void;
+  function invokeCallback(name: string, data?: any): any;
   /**
    * 创建新线程
    * @param threadJsFile 线程js文件路径
-   * @returns 线程id
+   * @returns 线程对象
+   * @example
+   * const newThread = thread.newThread("thread.js")
+   * newThread.addCallback("callback", (data) => {
+   *   console.log(data)
+   *   return "1111"
+   * })
    */
   function newThread(threadJsFile: string): {
+    /**
+     * 线程名称
+     */
+    name: string;
+    /**
+     * 添加回调函数
+     * @param callbackName 回调函数名称
+     * @param callbackFunc 回调函数
+     * @returns 是否添加成功
+     */
     addCallback: (
       callbackName: string,
       callbackFunc: (data?: any) => void
@@ -39,17 +69,33 @@ declare namespace thread {
    * 取消线程
    * @param name 线程名称
    * @returns 是否取消成功
+   * @example
+   * const newThread = thread.newThread("thread.js")
+   * newThread.addCallback("callback", (data) => {
+   *   console.log(data)
+   *   return "1111"
+   * })
+   * thread.cancelThread(newThread.name)
    */
   function cancelThread(name: string): boolean;
   /**
    * 检查线程是否已取消
    * @param name 线程名称
    * @returns 是否已取消
+   * @example
+   * const newThread = thread.newThread("thread.js")
+   * newThread.addCallback("callback", (data) => {
+   *   console.log(data)
+   *   return "1111"
+   * })
+   * thread.isCancelled(newThread.name)
    */
   function isCancelled(name: string): boolean;
   /**
    * 停止所有线程
    * @returns 是否停止成功
+   * @example
+   * thread.stopAll()
    */
   function stopAll(): boolean;
 }

package/types/ui.d.ts

@@ -1,31 +1,40 @@
 /**
- * 注册 UI 函数
+ * 注册UI函数 网页页面使用，给主进程调用
  * @param name 函数名称
  * @param func 函数
  */
 declare function registerUIFunc(name: string, func: (data: any) => void): void;
 
 /**
- * 发送事件
+ * 发送事件 网页页面使用 给主进程发送事件
  * @param event 事件名称
  * @param data 事件参数
  */
 declare function emitEvent(event: string, data: any): void;
 
+/**
+ * UI模块 包含加载html文件、调用js方法等功能
+ */
 declare namespace ui {
   interface WebView {
     /**
      * 显示WebView
+     * @example
+     * webview.show()
      */
     show(): void;
     /**
      * 关闭WebView
+     * @example
+     * webview.close()
      */
     close(): void;
     /**
      * 调用WebView中的方法
      * @param key 方法名
      * @param data 方法参数
+     * @example
+     * webview.call("jsMethod", "hello world")
      */
     call(key: string, data: any): void;
   }
@@ -34,6 +43,22 @@ declare namespace ui {
    * @param file 文件名
    * @param onEvent 事件回调
    * @returns WebView实例
+   * @example
+   * const webview = ui.newWebView("index.html", (event, data) => {
+   *   // 接收网页发送的事件
+   *   if(event === "page.loaded") {
+   *     console.log("页面加载完成")
+   *   } else if(event === "page.close") {
+   *     console.log("页面关闭")
+   *   } else if(event === "console.log") {
+   *     console.log("网页调用console.log", data)
+   *   } else {
+   *     // 自定义事件
+   *     console.log(event, data)
+   *   }
+   * })
+   * webview.show()
+   * webview.call("jsMethod", "hello world")
    */
   function newWebView(
     file: string,

package/types/utils.d.ts

@@ -1,37 +1,44 @@
+/**
+ * 工具模块 包含工具函数等功能
+ */
 declare namespace utils {
   /**
    * 格式化时间
    * @param format 格式化字符串
    * @returns 格式化后的时间字符串
+   * @example
+   * utils.timeFormat("yyyy-MM-dd hh:mm:ss")
    */
   function timeFormat(format: string): string;
   /**
    * 读取资源文件
    * @param fileName 文件名
    * @returns 文件内容
+   * @example
+   * utils.readResFile("test.txt")
    */
   function readResFile(fileName: string): string | null;
   /**
    * 读取资源图片
    * @param fileName 文件名
-   * @returns 图片内容
+   * @returns 返回 image 模块的 imageId
+   * @example
+   * utils.readResImage("test.png")
    */
   function readResImage(fileName: string): string | null;
-  /**
-   * 获取资源文件路径
-   * @param fileName 文件名
-   * @returns 资源文件路径
-   */
-  function getResFilePath(fileName: string): string;
   /**
    * 生成随机数
    * @param min 最小值
    * @param max 最大值
    * @returns 随机数
+   * @example
+   * utils.random(1, 10)
    */
   function random(min: number, max: number): number;
   /**
    * 将应用置入前台
+   * @example
+   * utils.takeMeToFront()
    */
   function takeMeToFront(): void;
 }

package/types/workerThread.d.ts

@@ -1,5 +1,6 @@
-declare const __workerName__: string;
-
+/**
+ * 工作线程模块 包含工作线程操作、工作线程回调等功能
+ */
 declare namespace workerThread {
   /**
    * 创建新线程

package/types/yolo.d.ts

@@ -1,53 +1,53 @@
 /**
- * YOLO目标检测模块类型定义
+ * YOLO检测结果
  */
-declare namespace yolo {
+declare interface YoloResult {
+  /**
+   * 检测框的左上角x坐标
+   */
+  x: number;
+  /**
+   * 检测框的左上角y坐标
+   */
+  y: number;
+  /**
+   * 检测框的右下角x坐标
+   */
+  ex: number;
+  /**
+   * 检测框的右下角y坐标
+   */
+  ey: number;
   /**
-   * YOLO检测结果
+   * 检测框的中心点x坐标
    */
-  type YoloResult = {
-    /**
-     * 检测框的左上角x坐标
-     */
-    x: number;
-    /**
-     * 检测框的左上角y坐标
-     */
-    y: number;
-    /**
-     * 检测框的右下角x坐标
-     */
-    ex: number;
-    /**
-     * 检测框的右下角y坐标
-     */
-    ey: number;
-    /**
-     * 检测框的中心点x坐标
-     */
-    centerX: number;
-    /**
-     * 检测框的中心点y坐标
-     */
-    centerY: number;
-    /**
-     * 检测框的宽度
-     */
-    width: number;
-    /**
-     * 检测框的高度
-     */
-    height: number;
-    /**
-     * 检测框的置信度
-     */
-    confidence: number;
-    /**
-     * 检测框的类别ID
-     */
-    classId: number;
-  };
+  centerX: number;
+  /**
+   * 检测框的中心点y坐标
+   */
+  centerY: number;
+  /**
+   * 检测框的宽度
+   */
+  width: number;
+  /**
+   * 检测框的高度
+   */
+  height: number;
+  /**
+   * 检测框的置信度
+   */
+  confidence: number;
+  /**
+   * 检测框的类别ID
+   */
+  classId: number;
+}
 
+/**
+ * YOLO目标检测模块 包含加载模型、目标检测等功能
+ */
+declare namespace yolo {
   /**
    * 加载YOLOv11模型
    * @param paramPath ncnn模型的param文件的绝对路径
@@ -55,6 +55,8 @@ declare namespace yolo {
    * @param nc 模型的标签数量,可在标签集data.yaml中看到
    * @param useGpu 是否启动gpu，默认用cpu
    * @returns 加载成功返回模型ID字符串，失败返回null
+   * @example
+   * const modelId = yolo.loadV11("yolov11n.param", "yolov11n.bin", 80, false)
    */
   function loadV11(
     paramPath: string,
@@ -71,6 +73,8 @@ declare namespace yolo {
    * @param threshold 置信度，默认0.4，小于这个值的会被过滤掉
    * @param nmsThreshold 重叠阈值，一般是0.5不需要更改
    * @returns 检测结果数组
+   * @example
+   * const results = yolo.detect(modelId, null, 640, 0.4, 0.5)
    */
   function detect(
     modelId: string,
@@ -83,11 +87,15 @@ declare namespace yolo {
   /**
    * 释放指定模型资源
    * @param modelId 模型ID
+   * @example
+   * yolo.free(modelId)
    */
   function free(modelId: string): void;
 
   /**
    * 释放所有模型资源
+   * @example
+   * yolo.freeAll()
    */
   function freeAll(): void;
 }