npm.io
4.2.1 • Published 4 weeks ago

@cloudbase/node-sdk

Licence
MIT
Version
4.2.1
Deps
12
Size
47 kB
Vulns
24
Weekly
0
Stars
26

Tencent Cloud Base(TCB) Server Node.js SDK

NPM Version node (scoped)

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

目录

介绍

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 字段。

安装

npm install --save @cloudbase/node-sdk

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

import tcb from "@cloudbase/node-sdk"

或

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

v4 架构升级

从 v4.0.0 开始,@cloudbase/node-sdk 的底层实现从独立的 Node.js SDK 切换为 @cloudbase/js-sdk,并直接重新导出 @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。

如需了解底层实现与更多能力,可参考 @cloudbase/js-sdk 文档。

文档

Keywords