# @cloudbase/js-sdk

> cloudbase javascript sdk

Latest version **3.11.1** (published 2026-11-16) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @cloudbase/js-sdk
pnpm add @cloudbase/js-sdk
yarn add @cloudbase/js-sdk
bun add @cloudbase/js-sdk
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; large bundle.

## Facts

| | |
|---|---|
| Version | 3.11.1 |
| Published | 2026-11-16 |
| First published | 2020-06-18 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 14 |
| Unpacked size | 26.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 47 |
| Maintainers | starkwang, yhyang, binggg, fengkx, liuyanjie, justan, woodenstone, miusuncle, yuzhen, wedabot, joeyren, byronpiao, yandrewding, areo-joe, coylexie, lukejyhuang |
| Keywords | tcb, cloudbase, Cloudbase, serverless, Serverless, javascript, JavaScript |

## Links

- npm: https://www.npmjs.com/package/@cloudbase/js-sdk
- Repository: https://github.com/TencentCloudBase/cloudbase-js-sdk
- Homepage: https://github.com/TencentCloudBase/cloudbase-js-sdk#readme
- Issues: https://github.com/TencentCloudBase/cloudbase-js-sdk/issues
- npm.io page: https://npm.io/package/@cloudbase/js-sdk

## Dependencies (14)

- [ws](https://npm.io/package/ws.md) ^8.18.0
- [bson](https://npm.io/package/bson.md) ^6.10.3
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [jwt-decode](https://npm.io/package/jwt-decode.md) ^3.1.2
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.7
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^9.0.0
- [text-encoding-shim](https://npm.io/package/text-encoding-shim.md) ^1.0.5
- [regenerator-runtime](https://npm.io/package/regenerator-runtime.md) ^0.14.1
- [web-streams-polyfill](https://npm.io/package/web-streams-polyfill.md) ^4.0.0
- [@cloudbase/adapter-wx_mp](https://npm.io/package/@cloudbase/adapter-wx_mp.md) ~1.4.0
- [@cloudbase/signature-nodejs](https://npm.io/package/@cloudbase/signature-nodejs.md) ^2.0.0
- [@cloudbase/adapter-interface](https://npm.io/package/@cloudbase/adapter-interface.md) ~0.7.1
- [@cloudbase/wx-cloud-client-sdk](https://npm.io/package/@cloudbase/wx-cloud-client-sdk.md) ^1.8.10
- [@mattiasbuelens/web-streams-adapter](https://npm.io/package/@mattiasbuelens/web-streams-adapter.md) ^0.1.0

## Recent versions

- 3.11.1 (latest) — 2026-11-16
- 3.11.2-beta.0 (beta) — 2026-11-19
- 3.9.5-alpha.0 (alpha) — 2026-09-16
- 3.7.2-cbf.12 (cbf) — 2026-08-12
- 2.32.0 (release-v2) — 2026-07-28
- 2.28.8 (v2) — 2026-05-25
- 3.3.9 (next) — 2026-05-08
- 2.9.6 (next_2025) — 2025-03-05
- 1.8.4 (v1beta) — 2024-12-27
- 1.7.4 (v1) — 2024-07-31
- 4.1.0-beta.3 — 2026-11-17
- 4.1.0-beta.2 — 2026-11-13
- 4.1.0-beta.1 — 2026-11-10
- 3.11.0 — 2026-11-02
- 4.1.0-beta.0 — 2026-10-29
- … 464 more at https://npm.io/package/@cloudbase/js-sdk/versions

## README

## @cloudbase/js-sdk

云开发 Cloudbase JavaScript SDK。

### 安装使用

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

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

#### 包管理器

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

引入时可选择全量引入：

```javascript
import cloudbase from '@cloudbase/js-sdk'
```

或者按需分模块引入：

```javascript
// 内核
import cloudbase from '@cloudbase/js-sdk/app'
// 登录模块
import cloudbase from '@cloudbase/js-sdk/auth'
// 函数模块
import cloudbase from '@cloudbase/js-sdk/functions'
// 云存储模块
import cloudbase from '@cloudbase/js-sdk/storage'
// 数据库模块
import cloudbase from '@cloudbase/js-sdk/database'
// 数据模型模块
import cloudbase from '@cloudbase/js-sdk/model'
```

#### 在 Node / 服务端（含 SSR）使用

在浏览器、小程序、Node.js / 服务端（含 Next.js、Nuxt 等 SSR）环境下，**直接安装 `@cloudbase/js-sdk` 即可，无需任何额外依赖，也无需在打包器中做任何配置**（例如不需要 `next.config.js` 里的 `serverExternalPackages` 或 `webpack` 兜底）。

SDK 的 Node 端部分能力依赖以下三个包，它们是**可选依赖**——仅当你在 Node 服务端**真正调用**对应能力时才需要安装：

| 能力 | 需要的可选依赖 | 安装命令 |
| --- | --- | --- |
| 自定义登录票据（`createTicket`） | `jsonwebtoken` | `npm install jsonwebtoken` |
| Node 环境请求签名 | `@cloudbase/signature-nodejs` | `npm install @cloudbase/signature-nodejs` |
| Node 环境 WebSocket（实时能力） | `ws` | `npm install ws` |

一次性安装全部：

```bash
npm install jsonwebtoken @cloudbase/signature-nodejs ws
```

> **为什么无需打包器配置**：这三个可选依赖并非在源码里以静态 `import '包名'` 或 `require('包名')`（字面量）的方式引用，而是通过内部的运行时加载工具按需加载——模块名在运行时由片段拼接得到、`require` 从宿主运行时获取。因此打包器（webpack / Next.js / Nuxt 等）在**静态分析阶段完全看不到这些模块名**，不会去解析它们，也就不会出现 `Module not found: Can't resolve 'xxx'` 报错。未安装时只有在 Node 运行时真正调用相关能力才会给出「请安装 xxx」的友好提示，纯浏览器 / 未用到这些能力的项目则完全无感。

#### CDN 引入

1. 引入全量 js 文件

   ```html
   <!-- 全量js文件 -->
   <script src="/cloudbase.full.js"></script>
   ```

2. 分模块引入
   ```html
   <!-- 主js文件 -->
   <script src="/cloudbase.js"></script>
   <!-- 登录模块 -->
   <script src="/cloudbase.auth.js"></script>
   <!-- 函数模块 -->
   <script src="/cloudbase.functions.js"></script>
   <!-- 云存储模块 -->
   <script src="/cloudbase.storage.js"></script>
   <!-- 数据库模块 -->
   <script src="/cloudbase.database.js"></script>
   <!-- 数据模型模块 -->
   <script src="/cloudbase.model.js"></script>
   ```

### 构建

构建分为两部分：

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

```bash
npm run build
```

---
_Source: https://npm.io/package/@cloudbase/js-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
