调用云函数

该模块允许用户创建、编写运行于知晓云云引擎上的代码。适用于一些对安全性有要求，功能复杂、需求个性化的业务场景。配合触发器可以帮助开发者实现功能复杂的小程序。

wx.BaaS.invoke(functionName, params, sync) (SDK >= 1.14.0)

调用云函数，需要先在控制台创建云函数 控制台 - 云函数新建云函数

参数说明

参数类型必填说每个
functionNameString是云函数名
paramsObject否传递给云函数的参数
syncBool否是否等待返回函数执行结果，默认为 true。同步与异步云函数有不同的超时时间，同步云函数为 5 秒，而异步云函数为 5 分钟（300 秒）

返回参数说明

参数类型描述
codeNumbercode 为 0 时表示成功执行云函数，否则为执行云函数失败
data由云函数返回的数据类型决定函数通过 callback 返回的数据
errorObject返回的错误信息，成功则返回空对象

请求示例

假设已经创建了一个云函数 helloWorld，其接受一个 name 作为参数，返回 hello ${name}。云函数代码如下：

  1. exports.main = function helloWorld(event, callback) {
  2.   console.log(event)
  3.   callback(null, `hello ${event.data.name}`)
  4. }

可在小程序中通过以下方式进行调用云函数：

  1. wx.BaaS.invoke('helloWorld', {name: 'allen'}).then(res => {
  2.   if (res.code === 0) {
  3.     // success
  4.     console.log(res.data)
  5.   } else {
  6.     // fail
  7.     console.log(res.error.message)
  8.   }
  9. }, err => {
  10.   // HError 对象
  11.   callback(err)
  12. })

返回参数

  1. {
  2.   "error": {},
  3.   "code": 0,
  4.   "data": "hello allen"
  5. }

HError 对象结构请参考错误码和 HError 对象

已废弃 wx.BaaS.invokeFunction(functionName, params, sync)

参数说明

参数类型必填说每个
functionNameString是云函数名
paramsObject否传递给云函数的参数
syncBool否是否等待返回函数执行结果，默认为 true。同步与异步云函数有不同的超时时间，同步云函数为 5 秒，而异步云函数为 5 分钟（300 秒）

返回参数说明

参数类型描述
codeNumbercode 为 0 时表示成功执行云函数，否则为执行云函数失败
data由云函数返回的数据类型决定函数通过 callback 返回的数据
errorObject返回的错误信息，成功则返回空对象

请求示例

假设已经创建了一个云函数 helloWorld，其接受一个 name 作为参数，返回 hello ${name}，可通过以下方式在云函数中进行调用

  1. wx.BaaS.invokeFunction('helloWorld', {name: 'allen'}).then(res => {
  2.   if (res.code === 0) {
  3.     // success
  4.     console.log(res.data)
  5.   } else {
  6.     // fail
  7.     console.log(res.error.message)
  8.   }
  9. })

返回参数

  1. {
  2.   "error": {},
  3.   "code": 0,
  4.   "data": "hello allen"
  5. }