vrv-mini-sdk
Version:
95 lines (70 loc) • 1.88 kB
Markdown
# 密信小程序SDK
## 通过 npm 安装
在现有项目中使用 MINI SDK 时,可以通过 npm 进行安装:
```
npm i vrv-mini-sdk
```
当然,你也可以通过 yarn 或 pnpm 进行安装:
```
# 通过 yarn 安装
yarn add vrv-mini-sdk
# 通过 pnpm 安装
pnpm add vrv-mini-sdk
```
## 通过 CDN 安装
使用 MINI SDK 最简单的方法是直接在 HTML 文件中引入 CDN 链接,之后你可以通过全局变量 miniSDK 访问到所有 API。
下载地址:[点击下载](https://unpkg.com/vrv-mini-sdk@1.0.0-beta.4/dist/),mini.js结尾的为最小体积版本,没有调试日志。
```html
<script src="https://unpkg.com/vrv-mini-sdk@1.0.0-beta.4/dist/mini-sdk.js"></script>
```
## 使用 ES 模块构建版本
MINI SDK采用单例模式开发,使用中要避免多次引用,否则会造成事件的重复绑定。
```javascript
import miniSDK from "vrv-mini-sdk";
miniSDK.init({
debug: true,
network: {
proxy: true,
bridge:{
debug: true,
}
}
})
Bridge.callMethod("requestProxy", {
url: "https://baidu.com",
method: "get",
}).then(res => {
console.log(res)
})
```
## 使用全局构建的版本
这里有一个使用全局构建版本的例子:
```html
<script src="https://unpkg.com/vrv-mini-sdk@1.0.0-beta.4/dist/mini-sdk.js"></script>
<div id="app">{{ message }}</div>
<script>
const {Bridge, Network} = miniSDK
miniSDK.init({
debug: true,
network: {
proxy: true
}
})
Bridge.callMethod("requestProxy", {
url: "https://baidu.com"
method: "get",
}).then(res => {
console.log(res)
})
</script>
```
## 开启调试模式
开启调试模式,详细的调用日志将会打印到控制台。
```javascript
miniSDK.init({
debug: true,
bridge:{
debug: true,
}
})
```