ms-types 0.0.11 → 0.0.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ms-types",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "type": "module",
   "license": "MIT",
   "publishConfig": {
@@ -9,11 +9,12 @@
   "files": [
     "types"
   ],
-  "typesVersions": {
-    "*": {
-      "*": [
-        "types/*"
-      ]
-    }
+  "scripts": {
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
+  },
+  "devDependencies": {
+    "vitepress": "^1.0.0"
   }
 }

package/types/action.d.ts

@@ -1,5 +1,5 @@
 /**
- * 操作相关函数
+ * 动作模块 包含点击、滑动、长按滑动、返回首页等动作
  */
 declare namespace action {
   /**
@@ -7,8 +7,9 @@ declare namespace action {
    * @param x 坐标x
    * @param y 坐标y
    * @param duration 持续时间
-   * @param jitter 抖动
+   * @param jitter 抖动 开启抖动，会在像素范围随机偏移 点击
    * @returns 点击是否成功
+   * @example action.click(100, 100, 20, true)
    */
   function click(
     x: number,
@@ -23,9 +24,10 @@ declare namespace action {
    * @param endX 结束坐标x
    * @param endY 结束坐标y
    * @param duration 持续时间
-   * @param jitter 抖动
-   * @param steps 步数
+   * @param jitter 抖动 开启抖动，会在像素范围随机偏移 滑动
+   * @param steps 步数 生成抖动点数量
    * @returns 滑动是否成功
+   * @example action.swipe(100, 100, 200, 200, 500, true, 10)
    */
   function swipe(
     startX: number,
@@ -45,9 +47,10 @@ declare namespace action {
    * @param touch_down_duration 按下持续时间
    * @param touch_move_duration 移动持续时间
    * @param touch_up_duration 松开持续时间
-   * @param jitter 抖动
-   * @param steps 步数
+   * @param jitter 抖动 开启抖动，会在像素范围随机偏移 长按滑动
+   * @param steps 步数 生成抖动点数量
    * @returns 长按滑动是否成功
+   * @example action.pressAndSwipe(100, 100, 200, 200, 500, 500, 500, true, 10)
    */
   function pressAndSwipe(
     startX: number,
@@ -63,19 +66,22 @@ declare namespace action {
   /**
    * 返回首页
    * @returns 返回首页是否成功
+   * @example action.homeScreen()
    */
   function homeScreen(): boolean;
   /**
    * 按下按钮
-   * @param button 按钮
+   * @param button 按钮 home 按下home键 volumeup 按下音量上键 volumedown 按下音量下键
    * @returns 按下按钮是否成功
+   * @example action.pressButton("home")
    */
   function pressButton(button: "home" | "volumeup" | "volumedown"): boolean;
   /**
-   * 按下HID按钮
-   * @param button HID按钮
-   * @param duration 持续时间
+   * 模拟按下HID按钮
+   * @param button HID按钮 home 按下home键 volumeup 按下音量上键 volumedown 按下音量下键 power 按下电源键 snapshot 按下截图键
+   * @param duration 持续时间 单位毫秒
    * @returns 按下HID按钮是否成功
+   * @example action.pressHidButton("home", 200)
    */
   function pressHidButton(
     button: "home" | "volumeup" | "volumedown" | "power" | "snapshot",

package/types/config.d.ts

@@ -1,34 +1,39 @@
 /**
- * 配置相关函数
+ * 配置模块 包含读取配置、更新配置、删除配置等功能
  */
 declare namespace config {
   /**
    * 读取配置Int
    * @param key 配置key
    * @returns 配置值
+   * @example config.readConfigInt("key")
    */
   function readConfigInt(key: string): number;
   /**
    * 读取配置Double
    * @param key 配置key
    * @returns 配置值
+   * @example config.readConfigDouble("key")
    */
   function readConfigDouble(key: string): number;
   /**
    * 读取配置String
    * @param key 配置key
    * @returns 配置值
+   * @example config.readConfigString("key")
    */
   function readConfigString(key: string): string;
   /**
    * 读取配置Bool
    * @param key 配置key
    * @returns 配置值
+   * @example config.readConfigBool("key")
    */
   function readConfigBool(key: string): boolean;
   /**
    * 获取所有配置JSON
    * @returns 所有配置JSON
+   * @example config.getConfigJSON()
    */
   function getConfigJSON(): Record<string, any>;
   /**
@@ -36,12 +41,14 @@ declare namespace config {
    * @param key 配置key
    * @param value 配置值
    * @returns 更新是否成功
+   * @example config.updateConfig("key", 100)
    */
   function updateConfig(key: string, value: any): boolean;
   /**
    * 删除配置
    * @param key 配置key
    * @returns 删除是否成功
+   * @example config.deleteConfig("key")
    */
   function deleteConfig(key: string): boolean;
 }

package/types/device.d.ts

@@ -1,10 +1,11 @@
 /**
- * 设备相关函数
+ * 设备模块 包含获取设备信息、设备操作等功能
  */
 declare namespace device {
   /**
    * 获取电池信息
    * @returns 电池信息
+   * @example device.getBatteryInfo()
    */
   function getBatteryInfo(): {
     /**
@@ -17,52 +18,67 @@ declare namespace device {
     isCharging: boolean;
   };
   /**
-   * 获取设备UDID
-   * @returns 设备UDID
+   * 获取设备ID
+   * @returns 设备ID
+   * @example device.getDeviceID()
    */
-  function getDeviceUDID(): string;
+  function getDeviceID(): string;
   /**
    * 获取设备名称
    * @returns 设备名称
+   * @example device.getDeviceName()
    */
   function getDeviceName(): string;
   /**
    * 获取设备型号
    * @returns 设备型号
+   * @example device.getDeviceModel()
    */
   function getDeviceModel(): string;
   /**
    * 获取屏幕大小
    * @returns 屏幕大小
+   * @example device.getScreenSize()
    */
   function getScreenSize(): {
+    /**
+     * 屏幕宽度
+     */
     width: number;
+    /**
+     * 屏幕高度
+     */
     height: number;
   };
   /**
    * 获取屏幕缩放比例
    * @returns 屏幕缩放比例
+   * @example device.getScreenScale()
    */
   function getScreenScale(): number;
   /**
-   * 获取设备方向
+   * 获取设备方向 PORTRAIT 竖屏 LANDSCAPE 横屏
    * @returns 设备方向
+   * @example device.getOrientation()
    */
   function getOrientation(): "PORTRAIT" | "LANDSCAPE";
   /**
-   * 获取系统版本
+   * 获取系统版本 例如 16.7.11
    * @returns 系统版本
+   * @example device.getOSVersion()
    */
   function getOSVersion(): string;
   /**
-   * 获取局域网IP
+   * 获取局域网IP 例如 192.168.1.100
    * @returns 局域网IP
+   * @example device.getLanIp()
    */
   function getLanIp(): string;
   /**
    * 振动
-   * @param duration 持续时间
+   * @param duration 持续时间 单位毫秒
    * @param intensity 强度 0.0-1.0
+   * @example device.vibrate(1000, 0.5)
    */
   function vibrate(duration: number, intensity: number): void;
 }

package/types/file.d.ts

@@ -1,11 +1,12 @@
 /**
- * 文件相关函数
+ * 文件模块 包含文件操作、文件内容读写等功能
  */
 declare namespace file {
   /**
    * 获取应用内部目录
    * @param type 目录类型
    * @returns 目录路径
+   * @example file.getInternalDir("documents")
    */
   function getInternalDir(
     type: "documents" | "library" | "temp" | "libraryCaches"
@@ -13,36 +14,42 @@ declare namespace file {
   /**
    * 获取应用数据目录
    * @returns 目录路径
+   * @example file.getDataDir()
    */
   function getDataDir(): string;
   /**
    * 获取应用数据文件路径
    * @param file 文件名
    * @returns 文件路径
+   * @example file.getDataFile("config.json")
    */
   function getDataFile(file: string): string;
   /**
    * 创建文件
    * @param path 文件路径
    * @returns 是否创建成功
+   * @example file.create("config.json")
    */
   function create(path: string): boolean;
   /**
    * 创建目录
    * @param path 目录路径
    * @returns 是否创建成功
+   * @example file.mkdirs("config")
    */
   function mkdirs(path: string): boolean;
   /**
    * 删除文件或目录
    * @param path 文件或目录路径
    * @returns 是否删除成功
+   * @example file.deleteAllFile("config")
    */
   function deleteAllFile(path: string): boolean;
   /**
    * 读取文件内容
    * @param path 文件路径
    * @returns 文件内容
+   * @example file.readFile("config.json")
    */
   function readFile(path: string): string;
   /**
@@ -51,13 +58,19 @@ declare namespace file {
    * @param line 行号 如果是-1 代表这个条件不生效
    * @param contains 包含内容 如果是null 代表这个条件不生效
    * @returns 是否删除成功
+   * @example file.deleteLine("config.json", 1, null)
    */
-  function deleteLine(path: string, line: number, contains?: string): boolean;
+  function deleteLine(
+    path: string,
+    line: number,
+    contains: string | null
+  ): boolean;
   /**
    * 列出目录下所有文件
    * @param path 目录路径
    * @param recursion 是否递归
    * @returns 文件路径数组
+   * @example file.listDir("config", true)
    */
   function listDir(path: string, recursion: boolean): string[];
   /**
@@ -65,6 +78,7 @@ declare namespace file {
    * @param path 文件路径
    * @param content 文件内容
    * @returns 是否写入成功
+   * @example file.writeFile("config.json", "name=wda")
    */
   function writeFile(path: string, content: string): boolean;
   /**
@@ -72,6 +86,7 @@ declare namespace file {
    * @param path 文件路径
    * @param content 文件内容
    * @returns 是否追加成功
+   * @example file.appendLine("config.json", "name=wda")
    */
   function appendLine(path: string, content: string): boolean;
   /**
@@ -79,18 +94,21 @@ declare namespace file {
    * @param path 文件路径
    * @param lineNo 行号
    * @returns 行内容
+   * @example file.readLine("config.json", 1)
    */
   function readLine(path: string, lineNo: number): string;
   /**
    * 读取文件所有行内容
    * @param path 文件路径
    * @returns 行内容数组
+   * @example file.readAllLines("config.json")
    */
   function readAllLines(path: string): string[];
   /**
    * 文件或者文件夹是否存在
    * @param path 文件路径
    * @returns 是否存在
+   * @example file.exists("config.json")
    */
   function exists(path: string): boolean;
   /**
@@ -98,12 +116,14 @@ declare namespace file {
    * @param src 源文件路径
    * @param dest 目标文件路径
    * @returns 是否复制成功
+   * @example file.copy("config.json", "config2.json")
    */
   function copy(src: string, dest: string): boolean;
   /**
    * 获取文件MD5值
    * @param path 文件路径
    * @returns 文件MD5值
+   * @example file.fileMD5("config.json")
    */
   function fileMD5(path: string): string | null;
 }

package/types/global.d.ts

@@ -22,6 +22,14 @@ declare const __appName__: string;
  * 应用 bundleId
  */
 declare const __bundleId__: string;
+/**
+ * 当前线程名称
+ */
+declare const __threadName__: string;
+/**
+ * 当前进程名称
+ */
+declare const __workerName__: string;
 /**
  * 应用包信息
  */

package/types/http.d.ts

@@ -1,8 +1,16 @@
+/**
+ * HTTP模块 包含发送HTTP请求、下载文件等功能、websocket等功能
+ */
 declare namespace http {
   /**
    * 通用发送HTTP请求
    * @param params 请求参数
    * @returns 请求结果
+   * @example
+   * http.request({
+   *   url: "https://www.baidu.com",
+   *   method: "GET",
+   * })
    */
   function request(params: {
     /**
@@ -116,6 +124,8 @@ declare namespace http {
    * @param timeout 超时时间
    * @param headers 请求头
    * @returns 下载是否成功
+   * @example
+   * http.downloadFile("https://www.baidu.com", "baidu.html")
    */
   function downloadFile(
     url: string,
@@ -131,6 +141,8 @@ declare namespace http {
    * @param timeout 超时时间
    * @param headers 请求头
    * @returns 请求结果
+   * @example
+   * http.httpGet("https://www.baidu.com")
    */
   function httpGet(
     url: string,
@@ -147,6 +159,8 @@ declare namespace http {
    * @param timeout 超时时间
    * @param headers 请求头
    * @returns 请求结果
+   * @example
+   * http.httpPost("https://www.baidu.com")
    */
   function httpPost(
     url: string,
@@ -163,6 +177,11 @@ declare namespace http {
    * @param timeout 超时时间
    * @param headers 请求头
    * @returns 请求结果
+   * @example
+   * http.postJSON("https://www.baidu.com", {
+   *   "name": "MagicScript",
+   *   "version": "1.0.0"
+   * })
    */
   function postJSON(
     url: string,
@@ -171,6 +190,9 @@ declare namespace http {
     headers?: Record<string, string>
   ): string;
 
+  /**
+   * WebSocket连接
+   */
   interface WebSocket {
     /**
      * 连接WebSocket服务器
@@ -262,6 +284,14 @@ declare namespace http {
    * @param url 连接地址
    * @param header 连接头
    * @returns WebSocket连接对象
+   * @example
+   * const ws = http.newWebsocket("ws://www.baidu.com")
+   * ws.connect()
+   * ws.onText((data) => {
+   *   console.log(data)
+   * })
+   * ws.sendText("hello")
+   * ws.close()
    */
   function newWebsocket(
     url: string,