Skip to content

Commit 3305cff

Browse files
committed
细化云函数参数的文档
1 parent fb61274 commit 3305cff

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

API.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,15 @@ AV.Cloud.define(name: string, options: object, func: function)
5050
`Request` 上的属性包括:
5151

5252
* `params: object`:客户端发送的参数,当使用 `rpc` 调用时,也可能是 `AV.Object`.
53-
* `user?: AV.User`:客户端所关联的用户(根据客户端发送的 `LC-Session` 头)。
54-
* `meta: {remoteAddress}`:客户端的 IP.
53+
* `currentUser?: AV.User`:客户端所关联的用户(根据客户端发送的 `LC-Session` 头)。
54+
* `user?: AV.User`:同 `currentUser`.
55+
* `meta: {remoteAddress}``meta.remoteAddress` 是客户端的 IP.
56+
* `sessionToken?: string`:客户端发来的 sessionToken(`X-LC-Session` 头)。
5557
5658
`Response` 上的属性包括:
5759
58-
* `success: function(result)`:向客户端发送结果,可以是包括 AV.Object 在内的各种数据类型或数组,客户端解析方式见各 SDK 文档。
59-
* `error: function(err: string)`:向客户端返回一个错误。
60+
* `success: function(result?)`:向客户端发送结果,可以是包括 AV.Object 在内的各种数据类型或数组,客户端解析方式见各 SDK 文档。
61+
* `error: function(err?: string)`:向客户端返回一个错误。
6062

6163
### AV.Cloud.run
6264

@@ -96,7 +98,8 @@ after 类 Hook 的 `func` 签名:`function(request: Request)`。
9698
`Request` 上的属性包括:
9799

98100
* `object: AV.Object`:被操作的对象。
99-
* `user?: AV.User`:发起操作的用户。
101+
* `currentUser?: AV.User`:发起操作的用户。
102+
* `user?: AV.User`:同 `currentUser`.
100103

101104
`Response` 上的属性包括:
102105

@@ -114,7 +117,8 @@ after 类 Hook 的 `func` 签名:`function(request: Request)`。
114117

115118
`Request` 上的属性包括:
116119

117-
* `user: AV.User`:被操作的用户。
120+
* `currentUser: AV.User`:被操作的用户。
121+
* `user: AV.User`:同 `currentUser`.
118122

119123
`Response` 上的属性包括:
120124

0 commit comments

Comments
 (0)