# @cloudbase/node-sdk

> tencent cloud base server sdk for node.js

Latest version **4.2.1** (published 2026-10-21) · MIT license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 4.2.1 |
| Published | 2026-10-21 |
| First published | 2019-12-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12 |
| Dependencies | 12 |
| Unpacked size | 47.5 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 26 |
| Author | lukejyhuang |
| Maintainers | starkwang, yhyang, binggg, fengkx, liuyanjie, justan, woodenstone, miusuncle, yuzhen, wedabot, joeyren, byronpiao, yandrewding, areo-joe, coylexie, lukejyhuang |
| Keywords | node sdk |

## Links

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

## Dependencies (12)

- [ws](https://npm.io/package/ws.md) ^8.21.0
- [bson](https://npm.io/package/bson.md) ^7.2.0
- [axios](https://npm.io/package/axios.md) 0.27.2
- [retry](https://npm.io/package/retry.md) ^0.13.1
- [form-data](https://npm.io/package/form-data.md) ^4.0.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.7.0
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^9.0.2
- [agentkeepalive](https://npm.io/package/agentkeepalive.md) ^4.3.0
- [http-proxy-agent](https://npm.io/package/http-proxy-agent.md) ^5.0.0
- [@cloudbase/js-sdk](https://npm.io/package/@cloudbase/js-sdk.md) ~3.10.2
- [https-proxy-agent](https://npm.io/package/https-proxy-agent.md) ^5.0.1
- [@cloudbase/signature-nodejs](https://npm.io/package/@cloudbase/signature-nodejs.md) ^2.2.0

## Recent versions

- 4.2.1 (latest) — 2026-10-21
- 3.18.8 (release-v3) — 2026-11-16
- 3.17.2 (beta) — 2026-02-06
- 3.17.1-alpha.0 (alpha) — 2026-01-28
- 4.2.0 — 2026-10-10
- 3.18.7 — 2026-10-05
- 3.18.6 — 2026-09-24
- 4.1.0 — 2026-09-07
- 3.18.5 — 2026-07-16
- 3.18.4 — 2026-07-02
- 3.18.3 — 2026-06-17
- 4.0.3 — 2026-06-16
- 4.0.2 — 2026-06-12
- 4.0.1 — 2026-06-10
- 4.0.0 — 2026-06-10
- … 104 more at https://npm.io/package/@cloudbase/node-sdk/versions

## README

# Tencent Cloud Base(TCB) Server Node.js SDK

[![NPM Version](https://img.shields.io/npm/v/@cloudbase/node-sdk)](https://www.npmjs.com/package/@cloudbase/node-sdk)
![node (scoped)](https://img.shields.io/node/v/@cloudbase/node-sdk)

Cloudbase Server Node.js SDK 让您可以在服务端（如腾讯云云函数或 云主机 等）使用 Node.js 服务访问 TCB 的的服务，如云函数调用，文件上传下载，数据库集合文档操作等，方便快速搭建应用。

## 目录

- [介绍](#介绍)
- [安装](#安装)
- [v4 架构升级](#v4-架构升级)
- [文档](#文档)

## 介绍

TCB 提供开发应用所需服务和基础设施。CloudBase server node.js SDK 让你可以在服务端（如腾讯云云函数或 云主机 等）使用 Node.js 服务访问 CloudBase 的的服务。

> 注意：从 `v3` 开始需要 Node.js `v12.0` 及以上版本，需要更低的 Node.js 版本可以选择 `v2` 版本。
> 注意：从 `v3` 版本开始，TCB 云函数中如果 `tcb.init({})` 未指定环境 ID，则使用当前云函数所在环境的环境 ID，而不是云开发默认环境 ID，即可以不再使用 `tcb.SYMBOL_CURRENT_ENV` 字段。

## 安装

```sh
npm install --save @cloudbase/node-sdk
```

要在你的项目中使用模块可以

```ts
import tcb from "@cloudbase/node-sdk"
```

或

```js
const tcb = require("@cloudbase/node-sdk")
```

## v4 架构升级

从 `v4.0.0` 开始，`@cloudbase/node-sdk` 的底层实现从独立的 Node.js SDK 切换为 **[`@cloudbase/js-sdk`](https://docs.cloudbase.net/api-reference/webv3/initialization)**，并直接重新导出 `@cloudbase/js-sdk`。

- 对使用者而言，**对外 API 完全保持不变**：仍然通过 `tcb.init()` 初始化，并调用 `database()`、`storage`、`callFunction()`、`callContainer()`、`auth()` 等方法。
- 底层能力与 `@cloudbase/js-sdk` 共享，从而保证服务端、Web、小程序等多端行为一致。
- 最低 Node.js 版本要求与 `@cloudbase/js-sdk` 保持一致。对于 Node.js `< 18` 的运行环境，SDK 会自动注入 `fetch` 的 polyfill，无需手动处理。

> 这是一个破坏性变更（`[breaking]`）：底层依赖由独立实现切换为 `@cloudbase/js-sdk`。如果你此前依赖了 node-sdk 私有实现中的未公开行为，请参考[从 v3 迁移到 v4](docs/migration-from-v3.md)。

如需了解底层实现与更多能力，可参考 [@cloudbase/js-sdk 文档](https://docs.cloudbase.net/api-reference/webv3/initialization)。

## 文档

- [从 v3 迁移到 v4](docs/migration-from-v3.md)
- [初始化](docs/initialization.md)
- [存储](docs/storage.md)
- [数据库](docs/database/database.md)
- [数据模型](./docs/models.md)
- [云函数/云函数2.0](docs/functions.md)
- [云托管](docs/cloudrun.md)
- [鉴权](./docs/auth.md)
- [环境](./docs/env.md)
- [通知消息](./docs/templateNotify.md)

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