Skip to content

Commit e258a7b

Browse files
authored
doc: update image and add cli-mind websocket laf client sdk (#1004)
1 parent e970a66 commit e258a7b

22 files changed

+119
-438
lines changed

.lycheeignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
.*xx.*
33
https://beian.miit.gov.cn/
44
.*127-0-0-1.*
5-
https://oss.laf.dev
5+
https://oss.laf.run

docs/.vitepress/config.js

+5-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ const NavConfig = [
1313
{
1414
text: "在线体验",
1515
// target: "_self",
16-
link: "https://laf.dev/",
16+
link: "https://laf.run/",
1717
},
1818
];
1919

@@ -120,7 +120,10 @@ const guideSiderbarConfig = [
120120
text: "laf-cli 命令行工具",
121121
items: [{ text: "laf-cli 使用说明", link: "/guide/cli/" }],
122122
},
123-
123+
{
124+
text: "laf-client-sdk",
125+
items: [{ text: "laf-client-sdk 使用说明", link: "/guide/client-sdk/" }],
126+
},
124127
];
125128

126129
/**

docs/doc-images/add-env.png

348 KB
Loading

docs/doc-images/add-packages.png

265 KB
Loading

docs/doc-images/create-injector.png

262 KB
Loading
53.4 KB
Loading

docs/doc-images/package-list.png

22.4 KB
Loading
178 KB
Loading

docs/doc-images/run-cloudfunction.png

149 KB
Loading

docs/guide/cli/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ cli 的主要功能就是把在 laf web 上的操作集成到命令行里,下
3030
```
3131
laf login [pat]
3232
```
33-
默认登录 `laf.dev`,如果要登录私有部署的 laf 可通过 `-r` 参数指定:
33+
默认登录 `laf.run`,如果要登录私有部署的 laf 可通过 `-r` 参数指定:
3434

35-
`laf login [pat] -r https://api.laf.dev`
35+
`laf login [pat] -r https://api.laf.run`
3636
::: tip
3737
这里要注意,https 后面需要加上 api
3838
:::

docs/guide/client-sdk/index.md

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: laf-client-sdk
3+
---
4+
5+
# {{ $frontmatter.title }}
6+
7+
## 介绍
8+
laf 为前端提供了 `laf-client-sdk` 适用于任何 js 运行环境。
9+
10+
## 安装
11+
12+
```bash
13+
npm install laf-client-sdk
14+
```
15+
16+
## 使用示例
17+
```js
18+
import { Cloud } from "laf-client-sdk";
19+
20+
const cloud = new Cloud({
21+
// 这里 APPID 需要换成对应的 APPID
22+
baseUrl: "https://APPID.laf.run",
23+
// 这里是访问策略的入口地址,如果没有访问策略可不填
24+
dbProxyUrl: "/proxy/app",
25+
// 请求时带的token,可空
26+
getAccessToken: () => localStorage.getItem("access_token"),
27+
});
28+
```
29+
30+
微信小程序中使用
31+
```js
32+
import { Cloud } from "laf-client-sdk";
33+
34+
const cloud = new Cloud({
35+
baseUrl: "https://APPID.laf.run",
36+
dbProxyUrl: "/proxy/app",
37+
getAccessToken: () => localStorage.getItem("access_token"),
38+
environment: "wxmp",
39+
});
40+
```
41+
42+
UNI-APP 中使用
43+
```js
44+
import { Cloud } from "laf-client-sdk";
45+
46+
const cloud = new Cloud({
47+
baseUrl: "https://APPID.laf.run",
48+
dbProxyUrl: "/proxy/app",
49+
getAccessToken: () => localStorage.getItem("access_token"),
50+
environment: "uniapp",
51+
});
52+
```
53+
54+
## 调用云函数
55+
56+
```ts
57+
import { Cloud } from "laf-client-sdk";
58+
59+
const cloud = new Cloud({
60+
baseUrl: "https://APPID.laf.run",
61+
dbProxyUrl: "/proxy/app",
62+
getAccessToken: () => localStorage.getItem("access_token"),
63+
});
64+
65+
// 调用 getCode 云函数,并且传入参数
66+
const res = await cloud.invoke("getCode", { phone: phone.value });
67+
```
68+
69+
## 操作数据库
70+
71+
```ts
72+
import { Cloud } from "laf-client-sdk";
73+
74+
const cloud = new Cloud({
75+
baseUrl: "https://APPID.laf.run",
76+
dbProxyUrl: "/proxy/app",
77+
getAccessToken: () => localStorage.getItem("access_token"),
78+
});
79+
// 获取用户表中的数据。
80+
const res = await db.collection('user').get()
81+
```
82+
83+
:::tip
84+
通过 client SDK 我们可以像在云函数中一样操作数据库,更多操作情参考 云数据库 章节。
85+
还有就是需要配合相对应的访问策略。
86+
:::

docs/guide/db/policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ npm i laf-client-sdk
5656
import { Cloud } from "laf-client-sdk";
5757

5858
const cloud = new Cloud({
59-
baseUrl: "https:/<APP_ID>.laf.dev", // <APP_ID> 在首页应用列表获取
59+
baseUrl: "https:/<APP_ID>.laf.run", // <APP_ID> 在首页应用列表获取
6060
getAccessToken: () => "", // 这里不需要授权,先填空
6161
dbProxyUrl: "/proxy/app", // 这里就填写我们刚刚强调的“入口地址”
6262
})

docs/guide/function/call-function-in-client.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ npm i laf-client-sdk
2121
import { Cloud } from "laf-client-sdk";
2222

2323
const cloud = new Cloud({
24-
baseUrl: "https:/<APP_ID>.laf.dev", // <APP_ID> 在首页应用列表获取
24+
baseUrl: "https:/<APP_ID>.laf.run", // <APP_ID> 在首页应用列表获取
2525
getAccessToken: () => "", // 这里不需要授权,先填空
2626
})
2727
```

docs/guide/function/env.md

+5-13
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,18 @@ title: 在云函数中使用环境变量
77

88
## 添加环境变量
99

10-
1. 首先点击页面左下角的小齿轮按钮,打开应用设置页面
10+
1. 首先点击页面左下角的小齿轮按钮,打开应用设置页面。
11+
2. 其次在弹出的应用设置界面,点击 新增环境变量按钮,输入环境变量的 `key``value`, 并点击确定。
12+
3. 确认更新环境变量。
1113

12-
![](/doc-images/add-env-step1.png)
14+
![](/doc-images/add-env.png)
1315

1416

15-
2. 其次在弹出的应用设置界面,点击 新增环境变量按钮,输入环境变量的 `key``value`, 并点击确定
16-
17-
![](/doc-images/add-env-step2.png)
18-
19-
3. 确认更新环境变量
20-
2117
::: warning
2218
请注意,更新环境变量需要重启当前应用以生效。
2319
重启期间应用将无法正常提供服务,因此在重启之前,请确保应用已暂停业务请求。
2420
:::
2521

26-
这里我们添加一个 `name``MY_ENV_KEY`, `value``MY_ENV_VALUE` 的环境变量,并等待应用重启完成。
27-
28-
![](/doc-images/add-env-step3.png)
29-
3022

3123
## 使用环境变量
3224

@@ -39,7 +31,7 @@ export async function main(ctx: FunctionContext) {
3931

4032
const env = cloud.env
4133
console.log(env)
42-
// 可以看到,我们刚才添加的 MY_ENV_NAME: MY_ENV_VALUE 已经生效了
34+
// 所有的环境变量都在 cloud.env 里面
4335
}
4436

4537
```

0 commit comments

Comments
 (0)