This package has been deprecated

Author message:

🙌 tcb-js-sdk 后续将不再迭代, 但我们推荐您使用升级后的 @cloudbase/js-sdk, 文档参考https://docs.cloudbase.net/api-reference/webv2/initialization.html

tcb-js-sdk

Tencent Cloud Base(TCB) JavaScript SDK

DEPRECATED 已更名@cloudbase/js-sdk，此仓库只维护现有能力不再增加新能力

介绍

TCB 提供开发应用所需服务和基础设施。TCB JS SDK 让你可以在网页端使用 JavaScript 代码服务访问 TCB 的的服务。你可以使用该 SDK 构建自己的公众号页面或者独立的网站等 Web 服务。

安装

TCB JS SDK 可以通过 tcb-js-sdk 来访问：

npm install --save tcb-js-sdk@latest

要在你的模块式使用模块可以

const tcb = require('tcb-js-sdk');

或

import * as tcb from 'tcb-js-sdk';

或者使用官方的代码包

<script src="//imgcache.qq.com/qcloud/tcbjs/${version}/tcb.js">

最新版本与npm保持一致，可在tcb-js-sdk中的Versions一栏中查看。

快速上手

初始化

// 引用官方 JS CDN 文件直接使用
const app = tcb.init({
  env: '你的环境 Id'
});

// 模块化开发
const tcb = require('tcb-js-sdk');
const app = tcb.init({
  env: '你的环境 Id'
});

授权

// 获取 auth 对象
const auth = app.auth({
  persistence: 'local'
});
 
// 微信登录
await auth
  .weixinAuthProvider({
    appid: '微信 appId',
    scope: 'snsapi_base'
  })
  .signIn(function() {});

使用

// 调用云函数
const res = await app.callFunction({
  name: 'test',
  data: {
    str: base64
  }
});

文档

• 授权登录
• 存储
• 数据库
• 云函数

更新日志

查看 更新日志

注意

1.0.1 版本后，为了提高文件上传性能，文件上传方式修改为直接上传到对象存储，为了防止在使用过程中出现 CORS 报错，需要到 Web 控制台 / 用户管理 / 登录设置选项中设置安全域名。如果已有域名出现 CORS 报错，请删除安全域名，重新添加。

开发

安装依赖

npm install

或者

yarn

单元测试

npm test unit

E2E 测试

依赖 puppeteer，在部分 linux 系统下跑不起来

npm run e2e

构建

执行以下命令：

npm run build

会同时构建npm package和通用版全量js文件，如下：

• dist目录为npm package文件；
• tcb.js/${version}/tcb.js为通用版js文件。