ms-types 0.8.8 → 0.9.0

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ms-types",
3
- "version": "0.8.8",
3
+ "version": "0.9.0",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "publishConfig": {
package/types/global.d.ts CHANGED
@@ -161,6 +161,24 @@ declare function setAgentFastMode(enabled: boolean): boolean;
161
161
  */
162
162
  declare function getAgentFastMode(): boolean;
163
163
 
164
+ /**
165
+ * 设置脚本 CPU 自动限流
166
+ * @param enabled 是否开启自动限流
167
+ * @returns 实际是否开启自动限流
168
+ * @description 默认开启。开启后,脚本 API 在 CPU 占用接近系统杀进程阈值时会轻微让步,降低被系统终止的风险
169
+ * @example
170
+ * const enabled = setCpuAutoThrottle(true);
171
+ */
172
+ declare function setCpuAutoThrottle(enabled: boolean): boolean;
173
+
174
+ /**
175
+ * 获取脚本 CPU 自动限流当前状态,默认开启
176
+ * @returns 当前是否开启自动限流
177
+ * @example
178
+ * const enabled = getCpuAutoThrottle();
179
+ */
180
+ declare function getCpuAutoThrottle(): boolean;
181
+
164
182
  /**
165
183
  * 打印调试日志 - 输出调试级别的日志
166
184
  * 用于详细的程序执行信息、变量值和状态信息、函数调用跟踪
package/types/pip.d.ts CHANGED
@@ -1,51 +1,23 @@
1
1
  declare namespace pip {
2
- interface LogViewParams {
3
- /**
4
- * 悬浮窗宽度,不能小于 100
5
- */
6
- width: number;
7
- /**
8
- * 悬浮窗高度,不能小于 100
9
- */
10
- height: number;
11
- /**
12
- * 日志的字体大小
13
- */
14
- textSize: number;
15
- /**
16
- * 日志的文字颜色,格式如 #FFFFFF
17
- */
18
- textColor: string;
19
- /**
20
- * 日志的背景颜色,格式如 #000000
21
- */
22
- backgroundColor: string;
23
- }
24
- /**
25
- * 设置悬浮窗日志窗口的显示参数[显示日志窗口之前调用才会生效]
26
- * @param params 包含显示参数的字典
27
- */
28
- function setLogViewParams(params: LogViewParams): void;
29
2
  /**
30
3
  * 判断悬浮窗是否打开
31
4
  * @returns true代表开启了悬浮窗,false代表没有开启
32
5
  */
33
6
  function isPipActive(): boolean;
34
7
  /**
35
- * 显示日志窗口[App 必须在前台才可调用]
8
+ * 切换到日志模式[首次显示悬浮窗时 App 必须在前台]
36
9
  * 必须iOS设备支持悬浮窗功能,并且开启悬浮窗
37
- * @returns true代表成功,false代表失败
10
+ * @returns true代表已提交切换请求
38
11
  */
39
- function showLogWindow(): boolean;
12
+ function switchToLogMode(): boolean;
40
13
  /**
41
- * 关闭日志窗口[App 必须在前台才可调用]
42
- * @returns true代表成功,false代表失败
14
+ * 切换到保活模式[首次显示悬浮窗时 App 必须在前台]
15
+ * @returns true代表已提交切换请求
43
16
  */
44
- function closeLogWindow(): boolean;
17
+ function switchToKeepAliveMode(): boolean;
45
18
  /**
46
- * 设置是否允许悬浮窗控制脚本启停
47
- * @param ctrl true代表允许,false代表不允许
48
- * @returns true代表成功,false代表失败
19
+ * 切换到关闭模式
20
+ * @returns true代表已提交切换请求
49
21
  */
50
- function setPipCtrlScript(ctrl: boolean): boolean;
22
+ function switchToOffMode(): boolean;
51
23
  }
package/types/system.d.ts CHANGED
@@ -161,15 +161,16 @@ declare namespace system {
161
161
  function notify(msg: string, title?: string, id?: string): void;
162
162
  /**
163
163
  * 获取内存使用信息
164
- * @returns 内存使用信息,包含已使用内存、可用内存、总内存和使用率(单位:MB)
164
+ * @returns 内存使用信息,包含应用占用、系统可用/总量、系统已用和系统占用率(单位:MB)
165
165
  * @example
166
166
  * const memInfo = system.getMemoryInfo()
167
- * logi(`已使用: ${memInfo.used}MB, 可用: ${memInfo.available}MB, 总计: ${memInfo.total}MB, 使用率: ${memInfo.usagePercentage}%`)
167
+ * logi(`应用: ${memInfo.used}MB, 系统: ${memInfo.systemUsed}/${memInfo.total}MB, 占用: ${memInfo.usagePercentage}%`)
168
168
  */
169
169
  function getMemoryInfo(): {
170
170
  used: number;
171
171
  available: number;
172
172
  total: number;
173
+ systemUsed: number;
173
174
  usagePercentage: number;
174
175
  };
175
176
  /**
@@ -196,6 +197,22 @@ declare namespace system {
196
197
  * logi(`系统总内存: ${totalMemory}MB`)
197
198
  */
198
199
  function getTotalMemory(): number;
200
+ /**
201
+ * 获取系统已用内存
202
+ * @returns 系统已用内存大小(单位:MB,物理内存总量减去可用内存)
203
+ * @example
204
+ * const systemUsed = system.getSystemUsedMemory()
205
+ * logi(`系统已用内存: ${systemUsed}MB`)
206
+ */
207
+ function getSystemUsedMemory(): number;
208
+ /**
209
+ * 获取 CPU 使用率
210
+ * @returns 当前应用 CPU 使用率(百分比)
211
+ * @example
212
+ * const cpuUsage = system.getCpuUsage()
213
+ * logi(`CPU 使用率: ${cpuUsage}%`)
214
+ */
215
+ function getCpuUsage(): number;
199
216
 
200
217
  /**
201
218
  * 启动 Agent 服务
@@ -157,6 +157,24 @@ declare function $设置Agent快速模式(是否开启: 布尔值): 布尔值;
157
157
  */
158
158
  declare function $获取Agent快速模式(): 布尔值;
159
159
 
160
+ /**
161
+ * 设置脚本 CPU 自动限流
162
+ * @param 是否开启 是否开启自动限流
163
+ * @returns 实际是否开启自动限流
164
+ * @description 默认开启。开启后,脚本 API 在 CPU 占用接近系统杀进程阈值时会轻微让步,降低被系统终止的风险
165
+ * @example
166
+ * const 是否开启 = $设置CPU自动限流(true);
167
+ */
168
+ declare function $设置CPU自动限流(是否开启: 布尔值): 布尔值;
169
+
170
+ /**
171
+ * 获取脚本 CPU 自动限流当前状态,默认开启
172
+ * @returns 当前是否开启自动限流
173
+ * @example
174
+ * const 是否开启 = $获取CPU自动限流();
175
+ */
176
+ declare function $获取CPU自动限流(): 布尔值;
177
+
160
178
  /**
161
179
  * 打印调试日志 - 输出调试级别的日志
162
180
  * 用于详细的程序执行信息、变量值和状态信息、函数调用跟踪
@@ -1,55 +1,27 @@
1
1
  /// <reference path="全局模块.d.ts" />
2
2
  /**
3
- * 悬浮窗模块 包含悬浮窗日志窗口的显示、关闭、设置参数等功能
3
+ * 悬浮窗模块 包含悬浮窗日志窗口的显示、关闭、状态查询等功能
4
4
  */
5
5
  declare namespace $悬浮窗 {
6
- interface 日志窗口参数 {
7
- /**
8
- * 悬浮窗宽度,不能小于 100
9
- */
10
- width: 数字;
11
- /**
12
- * 悬浮窗高度,不能小于 100
13
- */
14
- height: 数字;
15
- /**
16
- * 日志的字体大小
17
- */
18
- textSize: 数字;
19
- /**
20
- * 日志的文字颜色,格式如 #FFFFFF
21
- */
22
- textColor: 字符串;
23
- /**
24
- * 日志的背景颜色,格式如 #000000
25
- */
26
- backgroundColor: 字符串;
27
- }
28
- /**
29
- * 设置悬浮窗日志窗口的显示参数[显示日志窗口之前调用才会生效]
30
- * @param 参数 日志窗口参数
31
- */
32
- function 设置日志视图参数(参数: 日志窗口参数): 无返回值;
33
6
  /**
34
7
  * 判断悬浮窗是否打开
35
8
  * @returns true代表开启了悬浮窗,false代表没有开启
36
9
  */
37
10
  function 是否显示(): 布尔值;
38
11
  /**
39
- * 显示日志窗口[App 必须在前台才可调用]
12
+ * 切换到日志模式[首次显示悬浮窗时 App 必须在前台]
40
13
  * 必须iOS设备支持悬浮窗功能,并且开启悬浮窗
41
- * @returns true代表成功,false代表失败
14
+ * @returns true代表已提交切换请求
42
15
  */
43
- function 显示日志窗口(): 布尔值;
16
+ function 切换到日志模式(): 布尔值;
44
17
  /**
45
- * 关闭日志窗口[App 必须在前台才可调用]
46
- * @returns true代表成功,false代表失败
18
+ * 切换到保活模式[首次显示悬浮窗时 App 必须在前台]
19
+ * @returns true代表已提交切换请求
47
20
  */
48
- function 关闭日志窗口(): 布尔值;
21
+ function 切换到保活模式(): 布尔值;
49
22
  /**
50
- * 设置是否允许悬浮窗控制脚本启停
51
- * @param 是否允许 true代表允许,false代表不允许
52
- * @returns true代表成功,false代表失败
23
+ * 切换到关闭模式
24
+ * @returns true代表已提交切换请求
53
25
  */
54
- function 设置是否允许控制脚本启停(是否允许: 布尔值): 布尔值;
26
+ function 切换到关闭模式(): 布尔值;
55
27
  }
@@ -161,15 +161,16 @@ declare namespace $系统 {
161
161
  function 发送系统通知(消息: 字符串, 标题?: 字符串, 通知ID?: 字符串): 无返回值;
162
162
  /**
163
163
  * 获取内存使用信息
164
- * @returns 内存使用信息,包含已使用内存、可用内存、总内存和使用率(单位:MB)
164
+ * @returns 内存使用信息,包含应用占用、系统可用/总量、系统已用和系统占用率(单位:MB)
165
165
  * @example
166
166
  * const 内存信息 = $系统.获取内存使用信息()
167
- * $打印信息日志(`已使用: ${内存信息.used}MB, 可用: ${内存信息.available}MB, 总计: ${内存信息.total}MB, 使用率: ${内存信息.usagePercentage}%`)
167
+ * $打印信息日志(`应用: ${内存信息.used}MB, 系统: ${内存信息.systemUsed}/${内存信息.total}MB, 占用: ${内存信息.usagePercentage}%`)
168
168
  */
169
169
  function 获取内存使用信息(): {
170
170
  used: 数字;
171
171
  available: 数字;
172
172
  total: 数字;
173
+ systemUsed: 数字;
173
174
  usagePercentage: 数字;
174
175
  };
175
176
  /**
@@ -196,6 +197,22 @@ declare namespace $系统 {
196
197
  * $打印信息日志(`系统总内存: ${总内存}MB`)
197
198
  */
198
199
  function 获取系统总内存(): 数字;
200
+ /**
201
+ * 获取系统已用内存
202
+ * @returns 系统已用内存大小(单位:MB,物理内存总量减去可用内存)
203
+ * @example
204
+ * const 系统已用内存 = $系统.获取系统已用内存()
205
+ * $打印信息日志(`系统已用内存: ${系统已用内存}MB`)
206
+ */
207
+ function 获取系统已用内存(): 数字;
208
+ /**
209
+ * 获取 CPU 使用率
210
+ * @returns 当前应用 CPU 使用率(百分比)
211
+ * @example
212
+ * const CPU使用率 = $系统.获取CPU使用率()
213
+ * $打印信息日志(`CPU 使用率: ${CPU使用率}%`)
214
+ */
215
+ function 获取CPU使用率(): 数字;
199
216
 
200
217
  /**
201
218
  * 启动 Agent 服务