feat: uts-getbatteryinfo插件按照jsdoc规范注释

uni_modules/uts-getbatteryinfo/utssdk/app-android/index.uts

@@ -19,7 +19,9 @@ export default function getBatteryInfo(options: GetBatteryInfoOptions) {
             BatteryManager.BATTERY_PROPERTY_CAPACITY
         );
         const res = {
-            errMsg: 'getBatteryInfo:ok',
+            errCode: 0,
+            errSubject: "uni-getBatteryInfo",
+            errMsg: "getBatteryInfo:ok",
             level,
             isCharging: manager.isCharging()
         }
@@ -27,6 +29,8 @@ export default function getBatteryInfo(options: GetBatteryInfoOptions) {
         options.complete?.(res)
     } else {
         const res = {
+			errCode: 1001,
+			errSubject: "uni-getBatteryInfo",
             errMsg: 'getBatteryInfo:fail getAppContext is null'
         }
         options.fail?.(res)

uni_modules/uts-getbatteryinfo/utssdk/interface.uts

+type GetBatteryInfoResult = {
+	/**
+	 * 错误码
+	 */
+	errCode: number,
+	/**
+	 * 调用API的名称
+	 */
+	errSubject: string,
+	/**
+	 * 错误的详细信息
+	 */
+	errMsg: string,
+	/**
+	 * 设备电量，范围1 - 100
+	 */
+	level: number,
+	/**
+	 * 是否正在充电中
+	 */
+	isCharging: boolean
+}
+
+interface UniError<T> {
+	/**
+	 * 错误码
+	 */
+	errCode:T,
+	/**
+	 * 调用API的名称
+	 */
+	errSubject:string,
+	/**
+	 * 错误的详细信息
+	 */
+	errMsg:string,
+	/**
+	 * 错误来源
+	 */
+	cause:any
+}
+
+/**
+ * 错误码
+ */
+type GetBatteryInfoErrorCode = 
+	/** 成功 */ 
+	0
+	/** getAppContext is null */
+	| 1001
+	/** navigator.getBattery is unsupported */
+	| 1002
+;
+
+
+export type GetBatteryInfoOptions = {
+	/**
+	 * 接口调用结束的回调函数（调用成功、失败都会执行）
+	 */
+    success?: (res: GetBatteryInfoResult) => void
+	/**
+	 * 接口调用失败的回调函数
+	 */
+    fail?: (res: UniError<GetBatteryInfoErrorCode>) => void
+	/**
+	 * 接口调用成功的回调
+	 */
+    complete?: (res: object) => void
+}
+
+/**
+ * 获取电量信息
+ * @param {GetBatteryInfoOptions} options
+ * 
+ *
+ * @tutorial https://uniapp.dcloud.net.cn/api/system/batteryInfo.html
+ * @platforms APP-IOS = ^9.0,APP-ANDROID = ^22
+ * @since 3.6.11
+ * 
+ * @assert () => success({errCode: 0, errSubject: "uni-getBatteryInfo", errMsg: "getBatteryInfo:ok", level: 60, isCharging: false })
+ * @assert () => fail({errCode: 1001, errSubject: "uni-getBatteryInfo", errMsg: "getBatteryInfo:fail getAppContext is null" })
+ */
+export default function getBatteryInfo(options: GetBatteryInfoOptions): void
+

uni_modules/uts-getbatteryinfo/utssdk/web/index.js

@@ -11,6 +11,8 @@ export default function getBatteryInfo(options) {
         })
     } else {
         const res = {
+			errCode: 1002,
+			errSubject: "uni-getBatteryInfo",
             errMsg: 'getBatteryInfo:fail navigator.getBattery is unsupported'
         }
         options.fail && options.fail(res)