提交 21e1ab33 编写于 作者: 杜庆泉's avatar 杜庆泉

增加ts-doc注释

上级 4fa3cc70
export type GetBatteryInfoSuccess = { export type GetBatteryInfoSuccess = {
errMsg : string, errMsg : string,
/** /**
* 设备电量,范围1 - 100 * 设备电量,范围1 - 100
*/ */
level : number, level : number,
/** /**
* 是否正在充电中 * 是否正在充电中
*/ */
isCharging : boolean isCharging : boolean
} }
export type GetBatteryInfoFail = { export type GetBatteryInfoFail = {
/** /**
* 错误码 * 错误码
*/ */
errCode : number, errCode : number,
/** /**
* 调用API的名称 * 调用API的名称
*/ */
errSubject : string, errSubject : string,
/** /**
* 错误的详细信息 * 错误的详细信息
*/ */
errMsg : string, errMsg : string,
/** /**
* 错误来源 * 错误来源
*/ */
cause : any | null cause : any | null
} }
export type GetBatteryInfoOptions = { export type GetBatteryInfoOptions = {
/** /**
* 接口调用结束的回调函数(调用成功、失败都会执行) * 接口调用结束的回调函数(调用成功、失败都会执行)
*/ */
success ?: (res : GetBatteryInfoSuccess) => void success ?: (res : GetBatteryInfoSuccess) => void
/** /**
* 接口调用失败的回调函数 * 接口调用失败的回调函数
*/ */
fail ?: (res : GetBatteryInfoFail) => void fail ?: (res : GetBatteryInfoFail) => void
/** /**
* 接口调用成功的回调 * 接口调用成功的回调
*/ */
complete ?: (res : any) => void complete ?: (res : any) => void
} }
/** /**
...@@ -62,5 +62,38 @@ export type GetBatteryInfo = (options : GetBatteryInfoOptions) => void ...@@ -62,5 +62,38 @@ export type GetBatteryInfo = (options : GetBatteryInfoOptions) => void
interface Uni { interface Uni {
/**
* 获取电池电量信息
* @description 获取电池电量信息
* @param {GetBatteryInfoOptions} options
* @example
* ```typescript
* uni.getBatteryInfo({
* success(res) {
* console.log(res);
* }
* })
* ```
* @remark
* - 该接口需要同步调用
* @uniPlatform {
* "app": {
* "android": {
* "osVer": "4.4.4",
* "uniVer": "3.6.11",
* "unixVer": "3.9.0"
* },
* "ios": {
* "osVer": "8.0",
* "uniVer": "3.6.11",
* "unixVer": "3.9.0"
* }
* }
* }
* @uniVueVersion 2,3 //支持的vue版本
*
*/
getBatteryInfo : GetBatteryInfo getBatteryInfo : GetBatteryInfo
} }
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册