微信小程序开发文档 微信小程序云开发服务端API 初始化方法init

2024-02-25 开发教程 微信小程序开发文档 匿名 2

init

在调用云开发各 API 前,需先调用初始化方法 init 一次(全局只需一次)

init 方法的定义如下:

function init(options): void

init 方法接受一个可选的 options 参数,方法没有返回值。

options 参数定义了云开发的默认配置,该配置会作为之后调用其他所有云 API 的默认配置,options 提供的可选配置如下:

字段数据类型必填默认值说明
envstring | objectdefault默认环境配置,传入字符串形式的环境 ID 可以指定所有服务的默认环境,传入对象可以分别指定各个服务的默认环境,见下方详细定义

当 env 传入参数为对象时,可以指定各个服务的默认环境,可选字段如下:

字段数据类型必填默认值说明
databasestringdefault数据库 API 默认环境配置
storagestringdefault存储 API 默认环境配置
functionsstringdefault云函数 API 默认环境配置

示例代码:

const cloud = require('wx-server-sdk')
cloud.init({
env: 'test-x1dzi'
})

需要特别注意的是,在 wx-server-sdk 中不再兼容 success、fail、complete 回调,总是只会返回 Promise。