ms-vite-plugin 1.4.36 → 1.4.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/docs/api/pip.md +23 -3
  2. package/docs/api/thread.md +14 -7
  3. package/docs/apicn/pip.md +23 -3
  4. package/docs/apicn/thread.md +15 -8
  5. package/docs/apipython/pip.md +25 -3
  6. package/package.json +1 -1
package/docs/api/pip.md CHANGED
@@ -4,7 +4,8 @@
4
4
 
5
5
  ## 功能特性
6
6
 
7
- - **显示模式**：支持日志、保活和自定义三种显示模式；默认保活，不可关闭
7
+ - **显示模式**：支持日志、保活和自定义三种显示模式；首次安装默认保活
8
+ - **关闭控制**：支持主动关闭悬浮窗
8
9
  - **状态查询**：判断悬浮窗是否正在显示
9
10
  - **尺寸设置**：日志模式和自定义模式支持设置内容宽高，并按模式分别持久化
10
11
  - **日志显示**：日志模式支持设置日志文字大小
@@ -102,6 +103,25 @@ pip.setCustomTextColor("#34c759");
102
103
  pip.setCustomTextSize(18);
103
104
  ```
104
105
 
106
+ ### closeWindow - 关闭悬浮窗
107
+
108
+ ```typescript
109
+ function closeWindow(): boolean;
110
+ ```
111
+
112
+ 关闭悬浮窗。
113
+
114
+ **返回值：**
115
+
116
+ | 类型 | 描述 |
117
+ | --------- | ---------------------- |
118
+ | `boolean` | `true` 代表已提交请求 |
119
+
120
+ **示例：**
121
+
122
+ ```typescript
123
+ const success = pip.closeWindow();
124
+ ```
105
125
 
106
126
  ### setContentSize - 设置内容尺寸
107
127
 
@@ -109,7 +129,7 @@ pip.setCustomTextSize(18);
109
129
  function setContentSize(width: number, height: number): boolean;
110
130
  ```
111
131
 
112
- 设置日志模式或自定义模式的悬浮窗内容尺寸。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸；保活模式不会生效。
132
+ 设置日志模式或自定义模式的悬浮窗内容尺寸。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸；悬浮窗关闭状态和保活模式不会生效。
113
133
 
114
134
  **参数：**
115
135
 
@@ -288,7 +308,7 @@ pip.setContentSize(120, 180);
288
308
 
289
309
  ## 注意事项
290
310
 
291
- 1. **前台限制**：首次切换到日志、保活或自定义显示模式并启动悬浮窗时，App 必须在前台；悬浮窗已启动后可以继续切换显示模式。悬浮窗不可关闭，App 回到前台时若窗口不在会自动重建
311
+ 1. **前台限制**：首次切换到日志、保活或自定义显示模式并启动悬浮窗时，App 必须在前台；悬浮窗已启动后可以继续切换显示模式或关闭悬浮窗
292
312
  2. **设备兼容性**：仅支持 iOS 15+ 且具备画中画功能的设备
293
313
  3. **系统限制**：悬浮窗位置和实际显示尺寸由 iOS 管理
294
314
  4. **尺寸持久化**：日志模式和自定义模式分别保存尺寸，互不共用；保活模式不接受脚本尺寸
package/docs/api/thread.md CHANGED
@@ -12,7 +12,8 @@
12
12
 
13
13
  - **独立的执行环境**: 线程函数在独立的 JavaScript 环境中运行，无法访问主线程或其他作用域中的变量、函数或对象。
14
14
  - **闭包限制**: 即使线程函数是闭包形式，它也无法捕获外部变量。传递给 `thread.run` 的函数会被转换并在新的上下文中执行。
15
- - **数据通信**: 如果需要与主线程通信或使用外部数据，请使用 `sharedState` 全局对象。
15
+ - **启动参数**: 主线程可以向 `thread.run` 传入一个 Object，子线程通过全局变量 `__threadParams__` 读取。
16
+ - **数据通信**: 线程启动后的双向数据通信请使用 `sharedState` 全局对象。
16
17
  - **文件名限制**:执行的线程 js 文件名称必须以 `_thread.js` 结尾，例如 `worker_thread.js`。
17
18
 
18
19
  ## API 参考
@@ -24,14 +25,15 @@
24
25
  启动一个新的线程来执行指定的 JS 文件。
25
26
 
26
27
  ```typescript
27
- function run(threadJsFileName: string): Thread;
28
+ function run(threadJsFileName: string, params?: Record<string, any>): Thread;
28
29
  ```
29
30
 
30
31
  **参数:**
31
32
 
32
- | 参数名 | 类型 | 描述 |
33
- | ------------------ | -------- | ---------------- |
34
- | `threadJsFileName` | `string` | 线程 js 文件路径 |
33
+ | 参数名 | 类型 | 描述 |
34
+ | ------------------ | --------------------- | -------------------------------------------------- |
35
+ | `threadJsFileName` | `string` | 线程 js 文件路径 |
36
+ | `params` | `Record<string, any>` | 可选启动参数，只能传 Object；子线程通过 `__threadParams__` 读取 |
35
37
 
36
38
  **返回值:**
37
39
 
@@ -42,8 +44,13 @@ function run(threadJsFileName: string): Thread;
42
44
  **示例:**
43
45
 
44
46
  ```javascript
45
- // 启动一个简单的线程
46
- const t = thread.run("test_thread.js");
47
+ // 主线程传入启动参数
48
+ const t = thread.run("test_thread.js", { taskId: 1, title: "同步任务" });
49
+ ```
50
+
51
+ ```javascript
52
+ // test_thread.js
53
+ logi(`任务 ${__threadParams__.taskId}: ${__threadParams__.title}`);
47
54
  ```
48
55
 
49
56
  #### thread.stopAll - 停止所有线程
package/docs/apicn/pip.md CHANGED
@@ -4,7 +4,8 @@
4
4
 
5
5
  ## 功能特性
6
6
 
7
- - **显示模式**：支持日志、保活和自定义三种显示模式；默认保活，不可关闭
7
+ - **显示模式**：支持日志、保活和自定义三种显示模式；首次安装默认保活
8
+ - **关闭控制**：支持主动关闭悬浮窗
8
9
  - **状态查询**：判断悬浮窗是否正在显示
9
10
  - **尺寸设置**：日志模式和自定义模式支持设置内容宽高，并按模式分别持久化
10
11
  - **日志显示**：日志模式支持设置日志文字大小
@@ -102,6 +103,25 @@ $悬浮窗.设置自定义文字颜色("#34c759");
102
103
  $悬浮窗.设置自定义文字大小(18);
103
104
  ```
104
105
 
106
+ ### 关闭悬浮窗
107
+
108
+ ```typescript
109
+ function 关闭悬浮窗(): 布尔值;
110
+ ```
111
+
112
+ 关闭悬浮窗。
113
+
114
+ **返回值：**
115
+
116
+ | 类型 | 描述 |
117
+ | -------- | ---------------------- |
118
+ | `布尔值` | `true` 代表已提交请求 |
119
+
120
+ **示例：**
121
+
122
+ ```typescript
123
+ const 是否成功 = $悬浮窗.关闭悬浮窗();
124
+ ```
105
125
 
106
126
  ### 设置内容尺寸
107
127
 
@@ -109,7 +129,7 @@ $悬浮窗.设置自定义文字大小(18);
109
129
  function 设置内容尺寸(宽度: 数字, 高度: 数字): 布尔值;
110
130
  ```
111
131
 
112
- 设置日志模式或自定义模式的悬浮窗内容尺寸。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸；保活模式不会生效。
132
+ 设置日志模式或自定义模式的悬浮窗内容尺寸。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸；悬浮窗关闭状态和保活模式不会生效。
113
133
 
114
134
  **参数：**
115
135
 
@@ -288,7 +308,7 @@ $悬浮窗.设置内容尺寸(120, 180);
288
308
 
289
309
  ## 注意事项
290
310
 
291
- 1. **前台限制**：首次切换到日志、保活或自定义显示模式并启动悬浮窗时，App 必须在前台；悬浮窗已启动后可以继续切换显示模式。悬浮窗不可关闭，App 回到前台时若窗口不在会自动重建
311
+ 1. **前台限制**：首次切换到日志、保活或自定义显示模式并启动悬浮窗时，App 必须在前台；悬浮窗已启动后可以继续切换显示模式或关闭悬浮窗
292
312
  2. **设备兼容性**：仅支持 iOS 15+ 且具备画中画功能的设备
293
313
  3. **系统限制**：悬浮窗位置和实际显示尺寸由 iOS 管理
294
314
  4. **尺寸持久化**：日志模式和自定义模式分别保存尺寸，互不共用；保活模式不接受脚本尺寸
package/docs/apicn/thread.md CHANGED
@@ -12,7 +12,8 @@
12
12
 
13
13
  - **独立的执行环境**: 线程函数在独立的 JavaScript 环境中运行，无法访问主线程或其他作用域中的变量、函数或对象。
14
14
  - **闭包限制**: 即使线程函数是闭包形式，它也无法捕获外部变量。传递给 `$线程.运行` 的函数会被转换并在新的上下文中执行。
15
- - **数据通信**: 如果需要与主线程通信或使用外部数据，请使用 `$共享状态` 全局对象。
15
+ - **启动参数**: 主线程可以向 `$线程.运行` 传入一个 Object，子线程通过全局变量 `$线程参数` 读取。
16
+ - **数据通信**: 线程启动后的双向数据通信请使用 `$共享状态` 全局对象。
16
17
  - **文件名限制**:执行的线程 js 文件名称必须以 `_thread.js` 结尾，例如 `worker_thread.js`。
17
18
 
18
19
  ## API 参考
@@ -21,17 +22,18 @@
21
22
 
22
23
  #### $线程.运行 - 异步执行代码
23
24
 
24
- 启动一个新的线程来执行指定的函数。
25
+ 启动一个新的线程来执行指定的 JS 文件。
25
26
 
26
27
  ```typescript
27
- function 运行(线程函数: () => 无返回值): 线程;
28
+ function 运行(线程js文件名: 字符串, 启动参数?: 字典<任意类型>): 线程;
28
29
  ```
29
30
 
30
31
  **参数:**
31
32
 
32
- | 参数名 | 类型 | 描述 |
33
- | ---------- | ---------------- | ---------------------- |
34
- | `线程函数` | `() => 无返回值` | 要在子线程中执行的函数 |
33
+ | 参数名 | 类型 | 描述 |
34
+ | ---------------- | ---------------- | ---------------------------------------------- |
35
+ | `线程js文件名` | `字符串` | 线程 js 文件路径 |
36
+ | `启动参数` | `字典<任意类型>` | 可选启动参数，只能传 Object；子线程通过 `$线程参数` 读取 |
35
37
 
36
38
  **返回值:**
37
39
 
@@ -42,8 +44,13 @@ function 运行(线程函数: () => 无返回值): 线程;
42
44
  **示例:**
43
45
 
44
46
  ```javascript
45
- // 启动一个简单的线程
46
- const t = $线程.运行("test_thread.js");
47
+ // 主线程传入启动参数
48
+ const t = $线程.运行("test_thread.js", { 任务编号: 1, 标题: "同步任务" });
49
+ ```
50
+
51
+ ```javascript
52
+ // test_thread.js
53
+ $打印信息日志(`任务 ${$线程参数.任务编号}: ${$线程参数.标题}`);
47
54
  ```
48
55
 
49
56
  #### $线程.停止所有 - 停止所有线程
package/docs/apipython/pip.md CHANGED
@@ -4,7 +4,8 @@
4
4
 
5
5
  ## 功能特性
6
6
 
7
- - **显示模式**：支持日志、保活和自定义三种显示模式；默认保活，不可关闭
7
+ - **显示模式**：支持日志、保活和自定义三种显示模式；首次安装默认保活
8
+ - **关闭控制**：支持主动关闭悬浮窗
8
9
  - **状态查询**：判断悬浮窗是否正在显示
9
10
  - **尺寸设置**：日志模式和自定义模式支持设置内容宽高，并按模式分别持久化
10
11
  - **日志显示**：日志模式支持设置日志文字大小
@@ -108,10 +109,31 @@ pip.setCustomTextColor("#34c759")
108
109
  pip.setCustomTextSize(18)
109
110
  ```
110
111
 
112
+ ### closeWindow - 关闭悬浮窗
113
+
114
+ 关闭悬浮窗。
115
+
116
+ ```python
117
+ def closeWindow() -> bool
118
+ ```
119
+
120
+ **返回值：**
121
+
122
+ | 类型 | 描述 |
123
+ | ------ | --------------------- |
124
+ | `bool` | `True` 代表已提交请求 |
125
+
126
+ **示例：**
127
+
128
+ ```python
129
+ from kuaijs import pip
130
+
131
+ success = pip.closeWindow()
132
+ ```
111
133
 
112
134
  ### setContentSize - 设置内容尺寸
113
135
 
114
- 设置日志模式或自定义模式的悬浮窗内容尺寸。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸；保活模式不会生效。
136
+ 设置日志模式或自定义模式的悬浮窗内容尺寸。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸；悬浮窗关闭状态和保活模式不会生效。
115
137
 
116
138
  ```python
117
139
  def setContentSize(width: float, height: float) -> bool
@@ -308,7 +330,7 @@ pip.setContentSize(120, 180)
308
330
 
309
331
  ## 注意事项
310
332
 
311
- 1. **前台限制**：首次切换到日志、保活或自定义显示模式并启动悬浮窗时，App 必须在前台；悬浮窗已启动后可以继续切换显示模式。悬浮窗不可关闭，App 回到前台时若窗口不在会自动重建
333
+ 1. **前台限制**：首次切换到日志、保活或自定义显示模式并启动悬浮窗时，App 必须在前台；悬浮窗已启动后可以继续切换显示模式或关闭悬浮窗
312
334
  2. **设备兼容性**：仅支持 iOS 15+ 且具备画中画功能的设备
313
335
  3. **系统限制**：悬浮窗位置和实际显示尺寸由 iOS 管理
314
336
  4. **尺寸持久化**：日志模式和自定义模式分别保存尺寸，互不共用；保活模式不接受脚本尺寸
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ms-vite-plugin",
3
- "version": "1.4.36",
3
+ "version": "1.4.37",
4
4
  "type": "commonjs",
5
5
  "license": "MIT",
6
6
  "publishConfig": {