From 9b075b09967b6d2461a08113aa3b907a77d60bb8 Mon Sep 17 00:00:00 2001 From: DCloud-yyl Date: Fri, 11 Nov 2022 17:12:59 +0800 Subject: [PATCH] Update err-spec.md --- docs/tutorial/err-spec.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/tutorial/err-spec.md b/docs/tutorial/err-spec.md index ca6abdace..14b76ceae 100644 --- a/docs/tutorial/err-spec.md +++ b/docs/tutorial/err-spec.md @@ -74,19 +74,28 @@ function CallBack(err:UniError){ ``` -## 主题（模块）名称 +## 模块（主题）名称 + +errSubject属性值表示返回错误的调用模块名称。 |模块名称|描述| |----|----| -| uni-runtime | SDK错误，如没有配置模块 | +| uni-runtime | app端SDK运行环境错误 | | uni-secure-network | 安全网络 | | uni-ad | uni-AD | | uni-push | UniPush | | uni-login | OAuth（登录鉴权） | | uni-verify | 一键登录 | + **注意** -插件中返回错误时建议将“插件id”作为errSubject属性值，如果插件的API较多时可将每个API单独定义errSubject，建议使用errSubject属性值格式为“插件id-API名称”。 +- uni内置模块errSubject属性值为“uni-模块英文名称”，如果英文名称由多个单词组成，单词键应该加-分割 +- uni API的errSubject属性值 + + uni.XXX API时 + errSubject属性值为“uni-API名称”，如uni.getSystemInfo()，错误回调中errSubject属性值为“uni-getSystemInfo” + + Object.XX API时 + errSubject属性值为“uni-Object名称-API名称”，如SocketTask.onMessage()，错误回调中errSubject属性值为“uni-SocketTask-onMessage” +- uni插件中返回错误时建议将“插件id”作为errSubject属性值，如果插件的API较多时可将每个API单独定义errSubject，建议使用errSubject属性值格式为“插件id-API名称”。 -- GitLab