{"id":13654065,"url":"https://github.com/TencentCloudBase/tcb-js-sdk","last_synced_at":"2025-04-23T07:30:31.307Z","repository":{"id":57113308,"uuid":"196722766","full_name":"TencentCloudBase/tcb-js-sdk","owner":"TencentCloudBase","description":"云开发 JS SDK","archived":false,"fork":false,"pushed_at":"2021-08-03T07:15:17.000Z","size":3751,"stargazers_count":43,"open_issues_count":1,"forks_count":15,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-17T23:21:14.436Z","etag":null,"topics":["cloudbase","javascript-sdk","serverless"],"latest_commit_sha":null,"homepage":"https://docs.cloudbase.net/api-reference/web/initialization.html","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TencentCloudBase.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-13T13:07:37.000Z","updated_at":"2024-02-07T13:20:10.000Z","dependencies_parsed_at":"2022-08-22T02:31:10.168Z","dependency_job_id":null,"html_url":"https://github.com/TencentCloudBase/tcb-js-sdk","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TencentCloudBase%2Ftcb-js-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TencentCloudBase%2Ftcb-js-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TencentCloudBase%2Ftcb-js-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TencentCloudBase%2Ftcb-js-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TencentCloudBase","download_url":"https://codeload.github.com/TencentCloudBase/tcb-js-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249967617,"owners_count":21353279,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudbase","javascript-sdk","serverless"],"created_at":"2024-08-02T02:01:23.009Z","updated_at":"2025-04-23T07:30:29.940Z","avatar_url":"https://github.com/TencentCloudBase.png","language":"TypeScript","funding_links":[],"categories":["官方资源"],"sub_categories":[],"readme":"# Tencent Cloud Base(TCB) JavaScript SDK ![npm (tag)](https://img.shields.io/npm/v/tcb-js-sdk)\n\n**DEPRECATED 已更名[@cloudbase/js-sdk](https://github.com/TencentCloudBase/cloudbase-js-sdk)，此仓库只维护现有能力不再增加新能力**\n\n## 介绍\n\nTCB 提供开发应用所需服务和基础设施。TCB JS SDK 让你可以在网页端使用 JavaScript 代码服务访问 TCB 的的服务。你可以使用该 SDK 构建自己的公众号页面或者独立的网站等 Web 服务。\n\n## 安装\n\nTCB JS SDK 可以通过 `tcb-js-sdk` 来访问：\n\n```bash\nnpm install --save tcb-js-sdk@latest\n```\n\n要在你的模块式使用模块可以\n\n```js\nconst tcb = require('tcb-js-sdk');\n```\n\n或\n\n```js\nimport * as tcb from 'tcb-js-sdk';\n```\n\n或者使用官方的代码包\n\n```\n\u003cscript src=\"//imgcache.qq.com/qcloud/tcbjs/${version}/tcb.js\"\u003e\n```\n\n\u003e 最新版本与npm保持一致，可在[tcb-js-sdk](https://www.npmjs.com/package/tcb-js-sdk)中的Versions一栏中查看。\n\n## 快速上手\n\n### 初始化\n\n```javascript\n// 引用官方 JS CDN 文件直接使用\nconst app = tcb.init({\n  env: '你的环境 Id'\n});\n```\n\n```js\n// 模块化开发\nconst tcb = require('tcb-js-sdk');\nconst app = tcb.init({\n  env: '你的环境 Id'\n});\n```\n\n### 授权\n\n```js\n// 获取 auth 对象\nconst auth = app.auth({\n  persistence: 'local'\n});\n\n// 微信登录\nawait auth\n  .weixinAuthProvider({\n    appid: '微信 appId',\n    scope: 'snsapi_base'\n  })\n  .signIn(function() {});\n```\n\n### 使用\n\n```js\n// 调用云函数\nconst res = await app.callFunction({\n  name: 'test',\n  data: {\n    str: base64\n  }\n});\n```\n\n## 文档\n\n- [授权登录](docs/authentication.md)\n- [存储](docs/storage.md)\n- [数据库](docs/database.md)\n- [云函数](docs/functions.md)\n\n## 更新日志\n\n查看 [更新日志](./changelog.md)\n\n### 注意\n\n\u003e 1.0.1 版本后，为了提高文件上传性能，文件上传方式修改为直接上传到对象存储，为了防止在使用过程中出现 CORS 报错，需要到 Web 控制台 / 用户管理 / 登录设置选项中设置安全域名。如果已有域名出现 CORS 报错，请删除安全域名，重新添加。\n\n### 开发\n\n#### 安装依赖\n\n```\nnpm install\n```\n\n或者\n\n```\nyarn\n```\n\n#### 单元测试\n\n```\nnpm test unit\n```\n\n#### E2E 测试\n\n依赖 puppeteer，在部分 linux 系统下跑不起来\n\n```\nnpm run e2e\n```\n\n#### 构建\n执行以下命令：\n```bash\nnpm run build\n```\n会同时构建npm package和通用版全量js文件，如下：\n- `dist`目录为npm package文件；\n- `tcb.js/${version}/tcb.js`为通用版js文件。","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTencentCloudBase%2Ftcb-js-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTencentCloudBase%2Ftcb-js-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTencentCloudBase%2Ftcb-js-sdk/lists"}