## @cloudbase/js-sdk
[](https://www.npmjs.com/package/@cloudbase/js-sdk)
[](https://www.npmjs.com/package/@cloudbase/js-sdk)
云开发 Cloudbase JavaScript SDK,官方文档[参考](https://docs.cloudbase.net/api-reference/webv2/initialization.html)。
### 安装使用
@cloudbase/js-sdk 分为两种形式:
1. 全量-包含所有云开发功能 API;
2. 分模块-各功能拆分为细粒度的模块单独提供服务。
#### 包管理器
```bash
# npm
npm install @cloudbase/js-sdk -S
# yarn
yarn add @cloudbase/js-sdk
```
引入时可选择全量引入:
```javascript
import cloudbase from "@cloudbase/js-sdk"
```
或者按需分模块引入:
```javascript
// 内核
import cloudbase from "@cloudbase/js-sdk/app"
// 登录模块
import "@cloudbase/js-sdk/auth"
// 函数模块
import "@cloudbase/js-sdk/functions"
// 云存储模块
import "@cloudbase/js-sdk/storage"
// 数据库模块
import "@cloudbase/js-sdk/database"
// 数据库实时推送模块,必须引入数据库模块
import "@cloudbase/js-sdk/realtime"
```
#### CDN 引入
1. 引入全量 js 文件
```html
```
2. 分模块引入
```html
```
> 浏览器环境下分包模块引入后会自动注册至全局变量`cloudbase`。
### 构建
构建分为两部分:
1. 构建 npm 包,产出文件分属于各模块子目录;
2. 构建 CDN 托管的 js 文件,产出文件存放于`cdnjs`目录,按版本划分
```bash
npm run build
```
### 多平台兼容
Cloudbase JavaScript SDK 兼容浏览器运行时,若需在其他平台运行则需要搭配对应的适配器。
#### 全量引入
以 cocos 为例:
```javascript
const cloudbase = require("./cloudbase.full.js")
const { adapter } = require("cloudbase-adapter-cocos_native")
// 使用适配器
cloudbase.useAdapter(adapter)
const app = cloudbase.init({
// ...
})
```
#### 分包引入
以 cocos 为例,cloudbase 的分包模块只会在浏览器环境下自动注册,类似 cocos、微信小程序等非浏览器环境需要调用 API 手动注册:
```javascript
const cloudbase = require("./cloudbase.js")
const { registerAuth } = require("./cloudbase.auth.js")
const { registerFunctions } = require("./cloudbase.functions.js")
const { registerStorage } = require("./cloudbase.storage.js")
const { registerDatabase } = require("./cloudbase.database.js")
const { registerRealtime } = require("./cloudbase.realtime.js")
const { adapter } = require("cloudbase-adapter-cocos_native")
// 使用适配器
cloudbase.useAdapter(adapter)
// 注册分包模块
registerAuth(cloudbase)
registerFunctions(cloudbase)
registerStorage(cloudbase)
registerDatabase(cloudbase)
registerRealtime(cloudbase)
const app = cloudbase.init({
// ...
})
```
### 其他
- [更友好的错误提示](./docs/errlog.md)
- [开发指南](./docs/dev.md)
- [官方文档](https://docs.cloudbase.net/api-reference/webv2/initialization.html)
## 更新日志
查看 [更新日志](./changelog.md)