ms-types 0.0.61 → 0.0.63

package/package.json

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

package/types/global.d.ts

@@ -1,31 +1,48 @@
+declare type 回调 = Function;
+declare type 布尔值 = boolean;
+declare type 字符串 = string;
+declare type 数字 = number;
+declare type 任意类型 = any;
+declare type 日期时间 = Date;
+declare type 数组<T> = Array<T>;
+declare type 字典<T> = Record<string, T>;
+declare type 无返回值 = void;
+
 /**
  * 是否是调试模式
  */
 declare const __debug__: boolean;
+declare const $是否调试: boolean;
 /**
  * 是否应该退出应用
  */
 declare const __shouldExit__: boolean;
+declare const $是否退出: boolean;
 /**
  * 应用版本
  */
 declare const __appVersion__: string;
+declare const $APP应用版本: string;
 /**
  * 应用构建号
  */
 declare const __appBuildNumber__: string;
+declare const $APP应用构建号: string;
 /**
  * 应用名称
  */
 declare const __appName__: string;
+declare const $APP应用名称: string;
 /**
  * 应用 bundleId
  */
 declare const __bundleId__: string;
+declare const $APP应用包名: string;
 /**
  * 当前线程名称
  */
 declare const __threadName__: string;
+declare const $线程名称: string;
 /**
  * 应用包信息
  */
@@ -57,6 +74,16 @@ declare const __package__: {
   };
   [key: string]: any;
 };
+declare const $脚本配置: {
+  name: string;
+  appVersion: string;
+  appId: string;
+  update: {
+    url: string;
+    timeout: number;
+  };
+  [key: string]: any;
+};
 
 /**
  * 设置停止回调（仅主线程调用）
@@ -67,7 +94,18 @@ declare const __package__: {
  *   logi("脚本执行完成");
  * });
  */
-declare function setStopCallback(callback: () => void): void;
+declare function setStopCallback(callback: Function): void;
+
+/**
+ * 设置停止回调（仅主线程调用）
+ * @param callback 停止回调
+ * @description 脚本执行完成或异常停止时调用，exit 退出不会触发
+ * @example
+ * $设置停止回调(() => {
+ *   $打印信息日志("脚本执行完成");
+ * });
+ */
+declare const $设置停止回调: (回调: 回调) => 无返回值;
 
 /**
  * 设置异常停止回调（仅主线程调用）
@@ -80,6 +118,17 @@ declare function setStopCallback(callback: () => void): void;
  */
 declare function setExceptionCallback(callback: () => void): void;
 
+/**
+ * 设置异常停止回调（仅主线程调用）
+ * @param callback 异常停止回调
+ * @description 脚本执行异常停止时调用
+ * @example
+ * $设置异常停止回调(() => {
+ *   $打印错误日志("脚本执行异常");
+ * });
+ */
+declare const $设置异常停止回调: (回调: 回调) => 无返回值;
+
 /**
  * 重启脚本（仅主线程调用）
  * @param delay 延迟时间 毫秒
@@ -91,6 +140,15 @@ declare function setExceptionCallback(callback: () => void): void;
  */
 declare function restartScript(delay: number): void;
 
+/**
+ * 重启脚本（仅主线程调用）
+ * @param delay 延迟时间 毫秒
+ * @description 重启脚本会延迟指定时间后再重启，不要低于 2000 毫秒
+ * @example
+ * $重启脚本(2000);
+ */
+declare const $重启脚本: (延迟时间: 数字) => 无返回值;
+
 /**
  * 线程睡眠
  * @param ms 毫秒
@@ -99,14 +157,34 @@ declare function restartScript(delay: number): void;
  * sleep(1000);
  */
 declare function sleep(ms: number): void;
+
 /**
- * 退出应用
+ * 线程睡眠
+ * @param ms 毫秒
+ * @description 线程睡眠会阻塞当前线程，等待指定时间后继续执行
+ * @example
+ * $延时(1000);
+ */
+declare const $延时: (毫秒: 数字) => 无返回值;
+
+/**
+ * 退出脚本
  * @param exitAll 是否退出所有线程 true 退出所有 false 退出当前线程，不传默认 false
- * @description 退出应用会终止所有线程的执行
+ * @description 退出脚本会终止所有线程的执行
  * @example
  * exit();
  */
 declare function exit(exitAll?: boolean): void;
+
+/**
+ * 退出脚本
+ * @param 退出所有线程 是否退出所有线程 true 退出所有 false 退出当前线程，不传默认 false
+ * @description 退出脚本会终止所有线程的执行
+ * @example
+ * $退出脚本();
+ */
+declare const $退出脚本: (退出所有线程?: 布尔值) => 无返回值;
+
 /**
  * 获取当前时间戳
  * @returns 时间戳
@@ -114,6 +192,15 @@ declare function exit(exitAll?: boolean): void;
  * const timestamp = time();
  */
 declare function time(): number;
+
+/**
+ * 获取当前时间戳
+ * @returns 时间戳
+ * @example
+ * const timestamp = $获取当前时间戳();
+ */
+declare function $获取当前时间戳(): 数字;
+
 /**
  * 把 app 切换到前台 utils.takeMeToFront 的别名
  * @see utils.takeMeToFront
@@ -122,8 +209,18 @@ declare function time(): number;
  * takeMeToFront();
  */
 declare function takeMeToFront(): void;
+
 /**
- * 日志调试 - 输出调试级别的日志
+ * 把 app 切换到前台 utils.takeMeToFront 的别名
+ * @see utils.takeMeToFront
+ * @description 把 app 切换到前台
+ * @example
+ * $切入前台();
+ */
+declare function $APP切入前台(): 无返回值;
+
+/**
+ * 打印调试日志 - 输出调试级别的日志
  * 用于详细的程序执行信息、变量值和状态信息、函数调用跟踪
  * @param args 日志消息内容
  * @see logger.debug
@@ -132,8 +229,20 @@ declare function takeMeToFront(): void;
  * logd(`当前用户: ${username}`);
  */
 declare function logd(...args: any[]): void;
+
+/**
+ * 打印调试日志 - 输出调试级别的日志
+ * 用于详细的程序执行信息、变量值和状态信息、函数调用跟踪
+ * @param args 日志消息内容
+ * @see logger.debug
+ * @example
+ * $打印调试日志("程序开始执行");
+ * $打印调试日志(`当前用户: ${username}`);
+ */
+declare function $打印调试日志(...args: 数组<任意类型>): 无返回值;
+
 /**
- * 日志信息 - 输出信息级别的日志
+ * 打印信息日志 - 输出信息级别的日志
  * 用于程序正常运行信息、重要操作的确认、状态变更通知
  * @param args 日志消息内容
  * @see logger.info
@@ -142,8 +251,20 @@ declare function logd(...args: any[]): void;
  * logi("用户登录成功");
  */
 declare function logi(...args: any[]): void;
+
+/**
+ * 打印信息日志 - 输出信息级别的日志
+ * 用于程序正常运行信息、重要操作的确认、状态变更通知
+ * @param args 日志消息内容
+ * @see logger.info
+ * @example
+ * $打印信息日志("应用程序启动成功");
+ * $打印信息日志("用户登录成功");
+ */
+declare function $打印信息日志(...args: 数组<任意类型>): 无返回值;
+
 /**
- * 日志警告 - 输出警告级别的日志
+ * 打印警告日志 - 输出警告级别的日志
  * 用于潜在的问题、不推荐的操作、性能警告、兼容性问题
  * @param args 日志消息内容
  * @see logger.warn
@@ -152,8 +273,20 @@ declare function logi(...args: any[]): void;
  * logw("网络连接不稳定");
  */
 declare function logw(...args: any[]): void;
+
 /**
- * 日志错误 - 输出错误级别的日志
+ * 打印警告日志 - 输出警告级别的日志
+ * 用于潜在的问题、不推荐的操作、性能警告、兼容性问题
+ * @param args 日志消息内容
+ * @see logger.warn
+ * @example
+ * $打印警告日志("电池电量低于 20%");
+ * $打印警告日志("网络连接不稳定");
+ */
+declare function $打印警告日志(...args: 数组<任意类型>): 无返回值;
+
+/**
+ * 打印错误日志 - 输出错误级别的日志
  * 用于程序错误和异常、操作失败、系统错误、致命问题
  * @param args 日志消息内容
  * @see logger.error
@@ -162,3 +295,14 @@ declare function logw(...args: any[]): void;
  * loge("文件读取错误");
  */
 declare function loge(...args: any[]): void;
+
+/**
+ * 打印错误日志 - 输出错误级别的日志
+ * 用于程序错误和异常、操作失败、系统错误、致命问题
+ * @param args 日志消息内容
+ * @see logger.error
+ * @example
+ * $打印错误日志("网络请求失败");
+ * $打印错误日志("文件读取错误");
+ */
+declare function $打印错误日志(...args: 数组<任意类型>): 无返回值;