Skip to content

Commit 5e9df41

Browse files
committed
📝 Update API document
1 parent ef384fa commit 5e9df41

1 file changed

Lines changed: 21 additions & 16 deletions

File tree

API.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ AV.koa(options?: object)
2727
AV.koa2(options?: object)
2828
```
2929

30+
`options` 的属性包括:
31+
32+
- `onError?: function(err: Error)`:全局错误处理器,当云函数和 Hook 抛出异常时会调用该回调,可用于统一的错误报告。
33+
- `ignoreInvalidSessionToken?: boolean`:忽略客户端发来的错误的 sessionToken(`X-LC-Session` 头),而不是报错 `211 Could not find user`
34+
3035
## AV.Object
3136

3237
* `AV.Object#disableBeforeHook()`
@@ -113,12 +118,12 @@ AV.Cloud.run(name: string, params: object, options?: object): Promise<TaskInfo>
113118
114119
### 定义 Class Hook
115120
116-
* AV.Cloud.beforeSave
117-
* AV.Cloud.afterSave
118-
* AV.Cloud.beforeUpdate
119-
* AV.Cloud.afterUpdate
120-
* AV.Cloud.beforeDelete
121-
* AV.Cloud.afterDelete
121+
* `AV.Cloud.beforeSave`
122+
* `AV.Cloud.afterSave`
123+
* `AV.Cloud.beforeUpdate`
124+
* `AV.Cloud.afterUpdate`
125+
* `AV.Cloud.beforeDelete`
126+
* `AV.Cloud.afterDelete`
122127
123128
这些函数的签名:`function(className: string, func: function)`,其中 `func` 是接受一个 Request 对象作为参数,返回 Promise 的函数。在 before 类 Hook 中如果没有抛出异常则视作接受这次操作。如果抛出使用 `AV.Cloud.Error` 构造的异常表示客户端错误,拒绝本次操作;如果抛出其他类型的异常则视作服务器端错误,返回 500 响应并打印错误到标准输出,也会拒绝本次操作。
124129

@@ -134,8 +139,8 @@ LeanEngine 中间件会为这些 Hook 函数检查「Hook 签名」,确保调
134139

135140
### 登录和认证 Hook
136141

137-
* AV.Cloud.onVerified
138-
* AV.Cloud.onLogin
142+
* `AV.Cloud.onVerified`
143+
* `AV.Cloud.onLogin`
139144

140145
这两个函数的签名:`function(func: function)`,其中 `func` 是接受一个 Request 对象作为参数,返回 Promise 的函数,如果没有抛出异常则视作接受这次操作。
141146

@@ -148,14 +153,14 @@ LeanEngine 中间件会为这些 Hook 函数检查「Hook 签名」,确保调
148153

149154
包括:
150155

151-
* `onIMMessageReceived`
152-
* `onIMReceiversOffline`
153-
* `onIMMessageSent`
154-
* `onIMConversationStart`
155-
* `onIMConversationStarted`
156-
* `onIMConversationAdd`
157-
* `onIMConversationRemove`
158-
* `onIMConversationUpdate`
156+
* `AV.Cloud.onIMMessageReceived`
157+
* `AV.Cloud.onIMReceiversOffline`
158+
* `AV.Cloud.onIMMessageSent`
159+
* `AV.Cloud.onIMConversationStart`
160+
* `AV.Cloud.onIMConversationStarted`
161+
* `AV.Cloud.onIMConversationAdd`
162+
* `AV.Cloud.onIMConversationRemove`
163+
* `AV.Cloud.onIMConversationUpdate`
159164

160165
LeanEngine 中间件会为这些 Hook 函数检查「Hook 签名」,确保调用者的确是 LeanCloud 或本地调试时的命令行工具。
161166

0 commit comments

Comments
 (0)