跳到主要内容

从 tcb-js-sdk 迁移

@cloudbase/js-sdk 保留了 tcb-js-sdk 全部的核心概念,所以您可以沿袭使用 tcb-js-sdk 的大部分逻辑,在迁移过程中仅需要关注以下两点:

  • 全量变量
  • API 迁移

迁移指南#

全局变量#

tcb-js-sdk 暴露的全局变量名称为 tcb, @cloudbase/js-sdk 将全局变量更名为 cloudbase

API 迁移#

tcb-js-sdk 文档中标明的即将废弃的 API 在 @cloudbase/js-sdk 中不再提供,清单如下:

Auth.on() - 废弃#

废弃 tcb-js-sdk 用于监听登录相关事件的 API Auth.on(),@cloudbase/js-sdk 针对每种事件提供对应的监听 API,列表如下 |事件名称| API | |:--:|:--:| |loginStateExpire|Auth.onLoginStateExpired()| |loginStateChanged|Auth.onLoginTypeChanged()| |refreshAccessToken|Auth.onAccessTokenRefreshed()| |anonymousConverted|Auth.onAnonymousConverted()| |loginTypeChanged|Auth.onLoginTypeChanged()|

Auth.signInAnonymously() - 代替#

废弃 tcb-js-sdk 用于匿名登录的 API Auth.signInAnonymously(), @cloudbase/js-sdk 中提供 API AnonymousAuthProvider.signIn() 实现同样功能。

Auth.linkAndRetrieveDataWithTicket() - 代替#

废弃 tcb-js-sdk 用于匿名账号转正的 API Auth.linkAndRetrieveDataWithTicket(), @cloudbase/js-sdk 中提供 API User.linkWithTicket() 实现同样功能。

Auth.signInWithTicket() - 代替#

废弃 tcb-js-sdk 用于自定义登录的 API Auth.signInWithTicket(), @cloudbase/js-sdk 中提供 API CustomAuthProvider.signIn() 实现同样功能。

新版特性#

模块体系#

tcb-js-sdk 只能一次性引入全量 SDK,造成打包后的 JavaScript 文件体积过大,这对于只需要云开发部分功能的用户很不友好。@cloudbase/js-sdk 新增按需引入功能模块的特性,您可以根据自身业务需求引入对应的功能模块,详情请查看初始化章节。

更友好的语法提示#

如果您使用 TypeScript 或 VSCode 等具备语法提示功能的 IDE,将会在开发过程中体验到更友好的语法提示。