Web 端 SDK

最近更新时间:2025-12-16 16:07:42

我的收藏
@cloudbase/js-sdk 能让您可以在 Web 端(例如 PC Web 页面、微信公众平台 H5 等)使用 JavaScript 访问 Cloudbase 服务和资源。

安装

方式一:通过包管理器引入

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

方式二:通过 CDN 引入

通过 CDN 引入有两种方式:
引入全量 SDK
按需引入功能模块
<script src="https://static.cloudbase.net/cloudbase-js-sdk/latest/cloudbase.full.js"></script>
<script>
const app = cloudbase.init({
env: "your-env-id", // 替换为您的环境id
region: "ap-shanghai", // 不传默认为上海地域
});
</script>

<!-- 内核 -->
<script src="https://static.cloudbase.net/cloudbase-js-sdk/latest/cloudbase.js"></script>
<!-- 登录模块 -->
<script src="https://static.cloudbase.net/cloudbase-js-sdk/latest/cloudbase.auth.js"></script>
<!-- 数据库模块 -->
<script src="https://static.cloudbase.net/cloudbase-js-sdk/latest/cloudbase.database.js"></script>
<!-- 数据模型模块 -->
<script src="https://static.cloudbase.net/cloudbase-js-sdk/latest/cloudbase.model.js"></script>
<!-- 云函数模块 -->
<script src="https://static.cloudbase.net/cloudbase-js-sdk/latest/cloudbase.functions.js"></script>
<!-- 云存储模块 -->
<script src="https://static.cloudbase.net/cloudbase-js-sdk/latest/cloudbase.storage.js"></script>
<!-- 实时推送模块,引入前必须首先引入数据库模块 -->
<script src="https://static.cloudbase.net/cloudbase-js-sdk/latest/cloudbase.realtime.js"></script>
<!-- AI模块 -->
<script src="https://static.cloudbase.net/cloudbase-js-sdk/latest/cloudbase.ai.js"></script>
<script>
// 注册功能模块
registerAuth(cloudbase);
registerDatabase(cloudbase);
registerModel(cloudbase);
registerFunctions(cloudbase);
registerStorage(cloudbase);
registerRealtime(cloudbase);
registerAi(cloudbase);

const app = cloudbase.init({
env: "your-env-id", // 替换为您的环境id
region: "ap-shanghai", // 不传默认为上海地域
});
</script>

说明:
功能模块必须在内核之后引入,并且登录模块必须引入。
最新的版本号 version 可以前往 NPM 查看。

开发文档

说明:
新版 JavaScript SDK 已更名 @cloudbase/js-sdk,旧版本 tcb-js-sdk 未来不再更新,详情请参见 迁移指南