TencentCloudBase/cloudbase-js-sdk

@cloudbase/js-sdk

云开发 Cloudbase JavaScript SDK，官方文档参考。

安装使用

@cloudbase/js-sdk 分为两种形式：

全量-包含所有云开发功能 API；
分模块-各功能拆分为细粒度的模块单独提供服务。

包管理器

# npm
npm install @cloudbase/js-sdk -S
# yarn
yarn add @cloudbase/js-sdk

引入时可选择全量引入：

import cloudbase from "@cloudbase/js-sdk"

或者按需分模块引入：

// 内核
import cloudbase from "@cloudbase/js-sdk/app"
// 登录模块
import "@cloudbase/js-sdk/auth"
// 函数模块
import "@cloudbase/js-sdk/functions"
// 云存储模块
import "@cloudbase/js-sdk/storage"
// 数据库模块
import "@cloudbase/js-sdk/database"
// 数据库实时推送模块，必须引入数据库模块
import "@cloudbase/js-sdk/realtime"

CDN 引入

引入全量 js 文件

<!-- 全量js文件 -->
<script src="https://github.com/TencentCloudBase/cloudbase-js-sdk/raw/master/cloudbase.full.js"></script>

分模块引入

<!-- 主js文件 -->
<script src="https://github.com/TencentCloudBase/cloudbase-js-sdk/raw/master/cloudbase.js"></script>
<!-- 登录模块 -->
<script src="https://github.com/TencentCloudBase/cloudbase-js-sdk/raw/master/cloudbase.auth.js"></script>
<!-- 函数模块 -->
<script src="https://github.com/TencentCloudBase/cloudbase-js-sdk/raw/master/cloudbase.functions.js"></script>
<!-- 云存储模块 -->
<script src="https://github.com/TencentCloudBase/cloudbase-js-sdk/raw/master/cloudbase.storage.js"></script>
<!-- 数据库模块 -->
<script src="https://github.com/TencentCloudBase/cloudbase-js-sdk/raw/master/cloudbase.database.js"></script>
<!-- 数据库实时推送模块，必须引入数据库模块 -->
<script src="https://github.com/TencentCloudBase/cloudbase-js-sdk/raw/master/cloudbase.realtime.js"></script>

浏览器环境下分包模块引入后会自动注册至全局变量cloudbase。

构建

构建分为两部分：

构建 npm 包，产出文件分属于各模块子目录；
构建 CDN 托管的 js 文件，产出文件存放于cdnjs目录，按版本划分

npm run build

多平台兼容

Cloudbase JavaScript SDK 兼容浏览器运行时，若需在其他平台运行则需要搭配对应的适配器。

全量引入

以 cocos 为例：

const cloudbase = require("./cloudbase.full.js")
const { adapter } = require("cloudbase-adapter-cocos_native")
// 使用适配器
cloudbase.useAdapter(adapter)

const app = cloudbase.init({
  // ...
})

分包引入

以 cocos 为例，cloudbase 的分包模块只会在浏览器环境下自动注册，类似 cocos、微信小程序等非浏览器环境需要调用 API 手动注册：

const cloudbase = require("./cloudbase.js")
const { registerAuth } = require("./cloudbase.auth.js")
const { registerFunctions } = require("./cloudbase.functions.js")
const { registerStorage } = require("./cloudbase.storage.js")
const { registerDatabase } = require("./cloudbase.database.js")
const { registerRealtime } = require("./cloudbase.realtime.js")
const { adapter } = require("cloudbase-adapter-cocos_native")
// 使用适配器
cloudbase.useAdapter(adapter)

// 注册分包模块
registerAuth(cloudbase)
registerFunctions(cloudbase)
registerStorage(cloudbase)
registerDatabase(cloudbase)
registerRealtime(cloudbase)

const app = cloudbase.init({
  // ...
})

其他

更新日志

查看更新日志

TencentCloudBase / cloudbase-js-sdk

readme