From 34208acf364bd75e1a1aacc098edaac9c08962ba Mon Sep 17 00:00:00 2001 From: fxy060608 Date: Tue, 14 Mar 2023 16:43:56 +0800 Subject: [PATCH] Update extapi.md --- docs/api/extapi.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/api/extapi.md b/docs/api/extapi.md index 9402a822b..e5741cf6c 100644 --- a/docs/api/extapi.md +++ b/docs/api/extapi.md @@ -190,7 +190,22 @@ uni-app的runtime不适合内置很多waiting样式和资源，而使用三方 } ``` -- [示例(获取电量)参考](https://gitcode.net/dcloud/hello-uts/-/tree/dev/uni_modules/uni-getbatteryinfo) + +**注意：** + +- 所有 uni ext api 均需要提供 utssdk/interface.uts 文件 +- 所有对外暴露的方法，类型均需要在 interface.uts 中定义 +- 在具体平台实现中，通过引用 interface.uts 中的定义的方法，类型来约束实现 +- 命名规范： + * API入参类型命名为`API名称首字母大写 + 'Options'`， + > 如 uni.getBatteryInfo(options)，则 options 类型命名为：`type GetBatteryInfoOptions = {}` + * 异步API success,fail 回调结果类型命名为`API名称首字母大写 + 'Success'` 和 `API名称首字母大写 + 'Fail'` + > 如 uni.getBatteryInfo() 的 success,fail 回调结果类型为：`type GetBatteryInfoSuccess = {}` 和 `type GetBatteryInfoFail = {}` + * 事件API 回调结果类型命名为`API名称首字母大写 + 'CallbackResult'` + > 如 uni.onUserCaptureScreen 的 callback 回调结果类型为：`type OnUserCaptureScreenCallbackResult = {}` + +- [示例(获取电量)参考](https://gitcode.net/dcloud/uni-api/-/tree/dev/uni_modules/uni-getbatteryinfo) + ## 如何使用uni ext api -- GitLab