ms-types 0.9.13 → 0.9.15

package/package.json

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

package/types/cloud.d.ts

@@ -36,6 +36,7 @@ declare namespace cloud {
    * @param event 自定义事件名称。
    * @param data 可 JSON 序列化的普通 Object。
    * @returns 已连接且数据可写出时返回 true。
+   * @description 设备总览状态固定使用 cloud.report("cloud:status", data) 上报；data 的 key 必须是云控端已配置的自定义字段名，多余字段不会在设备总览显示。
    * @example
    * cloud.report("done", { value: 1 });
    */

package/types/global.d.ts

@@ -81,13 +81,21 @@ declare const sharedState: {
 /**
  * 设置停止回调（仅主线程调用，不能在线程脚本中调用）
  * @param callback 停止回调
- * @description 脚本执行完成或异常停止时调用，exit 退出不会触发
+ * @description 脚本执行停止时调用，success 表示正常停止，error 表示异常停止，stopped 表示手动停止
  * @example
- * setStopCallback(() => {
- *   logi("脚本执行完成");
+ * setStopCallback((status) => {
+ *   if (status === "success") {
+ *     logi("脚本执行完成");
+ *   } else if (status === "error") {
+ *     loge("脚本执行异常");
+ *   } else if (status === "stopped") {
+ *     logi("脚本手动停止");
+ *   }
  * });
  */
-declare function setStopCallback(callback: () => void): void;
+declare function setStopCallback(
+  callback: (status: "success" | "error" | "stopped") => void,
+): void;
 
 /**
  * 设置异常停止回调（仅主线程调用，不能在线程脚本中调用）
@@ -192,7 +200,10 @@ declare function getCpuAutoThrottle(): boolean;
  * @example
  * const delay = setCpuThrottleDelay(3, 30);
  */
-declare function setCpuThrottleDelay(minMs: number, maxMs: number): { minMs: number; maxMs: number };
+declare function setCpuThrottleDelay(
+  minMs: number,
+  maxMs: number,
+): { minMs: number; maxMs: number };
 
 /**
  * 获取 CPU 限流延迟范围（毫秒）

package/types/zh//344/272/221/346/216/247/346/250/241/345/235/227.d.ts

@@ -34,6 +34,7 @@ declare namespace $云控 {
    * @param 事件 自定义事件名称。
    * @param 数据 可 JSON 序列化的普通 Object。
    * @returns 已连接且数据可写出时返回 true。
+   * @description 设备总览状态固定使用 $云控.上报数据("cloud:status", 数据) 上报；数据的 key 必须是云控端已配置的自定义字段名，多余字段不会在设备总览显示。
    * @example
    * $云控.上报数据("done", { value: 1 });
    */

package/types/zh//345/205/250/345/261/200/346/250/241/345/235/227.d.ts

@@ -80,13 +80,21 @@ declare const $共享状态: {
 /**
  * 设置停止回调（仅主线程调用，不能在线程脚本中调用）
  * @param callback 停止回调
- * @description 脚本执行完成或异常停止时调用，exit 退出不会触发
+ * @description 脚本执行停止时调用，success 表示正常停止，error 表示异常停止，stopped 表示手动停止
  * @example
- * $设置停止回调(() => {
- *   $打印信息日志("脚本执行完成");
+ * $设置停止回调((状态) => {
+ *   if (状态 === "success") {
+ *     $打印信息日志("脚本执行完成");
+ *   } else if (状态 === "error") {
+ *     $打印错误日志("脚本执行异常");
+ *   } else if (状态 === "stopped") {
+ *     $打印信息日志("脚本手动停止");
+ *   }
  * });
  */
-declare const $设置停止回调: (回调: () => 无返回值) => 无返回值;
+declare const $设置停止回调: (
+  回调: (状态: "success" | "error" | "stopped") => 无返回值,
+) => 无返回值;
 
 /**
  * 设置异常停止回调（仅主线程调用，不能在线程脚本中调用）