https://github.com/TencentCloudBase/tcb-js-sdk

云开发 JS SDK
https://github.com/TencentCloudBase/tcb-js-sdk

cloudbase javascript-sdk serverless

Last synced: about 2 months ago
JSON representation

云开发 JS SDK

• Host: GitHub
• URL: https://github.com/TencentCloudBase/tcb-js-sdk
• Owner: TencentCloudBase
• Created: 2019-07-13T13:07:37.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-08-03T07:15:17.000Z (over 3 years ago)
• Last Synced: 2024-10-28T22:39:56.698Z (2 months ago)
• Topics: cloudbase, javascript-sdk, serverless
• Language: TypeScript
• Homepage: https://docs.cloudbase.net/api-reference/web/initialization.html
• Size: 3.58 MB
• Stars: 43
• Watchers: 10
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md

Awesome Lists containing this project

README

        
# Tencent Cloud Base(TCB) JavaScript SDK ![npm (tag)](https://img.shields.io/npm/v/tcb-js-sdk)

**DEPRECATED 已更名[@cloudbase/js-sdk](https://github.com/TencentCloudBase/cloudbase-js-sdk)，此仓库只维护现有能力不再增加新能力**

## 介绍

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

## 安装

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

```bash

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

```

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

```js

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

```

或

```js

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

```

或者使用官方的代码包

```

```

> 最新版本与npm保持一致，可在[tcb-js-sdk](https://www.npmjs.com/package/tcb-js-sdk)中的Versions一栏中查看。

## 快速上手

### 初始化

```javascript

// 引用官方 JS CDN 文件直接使用

const app = tcb.init({

  env: '你的环境 Id'

});

```

```js

// 模块化开发

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

const app = tcb.init({

  env: '你的环境 Id'

});

```

### 授权

```js

// 获取 auth 对象

const auth = app.auth({

  persistence: 'local'

});

// 微信登录

await auth

  .weixinAuthProvider({

    appid: '微信 appId',

    scope: 'snsapi_base'

  })

  .signIn(function() {});

```

### 使用

```js

// 调用云函数

const res = await app.callFunction({

  name: 'test',

  data: {

    str: base64

  }

});

```

## 文档

- [授权登录](docs/authentication.md)

- [存储](docs/storage.md)

- [数据库](docs/database.md)

- [云函数](docs/functions.md)

## 更新日志

查看 [更新日志](./changelog.md)

### 注意

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

### 开发

#### 安装依赖

```

npm install

```

或者

```

yarn

```

#### 单元测试

```

npm test unit

```

#### E2E 测试

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

```

npm run e2e

```

#### 构建

执行以下命令：

```bash

npm run build

```

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

- `dist`目录为npm package文件；

- `tcb.js/${version}/tcb.js`为通用版js文件。