Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: optimize cloud function document && add document search function #1057

Merged
merged 1 commit into from
Apr 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,10 @@ const guideSiderbarConfig = [
},
],
},
{
text: "云函数日志",
link: "/guide/function/logs",
},
{
text: "依赖管理",
link: "/guide/function/depend",
Expand Down
Binary file added docs/doc-images/change-package-version.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/doc-images/delete-package.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/doc-images/function-log.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions docs/guide/function/call-function.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ title: 在云函数中调用

云函数在开发完毕并发布后,可以在其他云函数中进行调用。

::: info
`cloud.invoke`方法已不推荐使用,可使用[引入云函数](/guide/function/use-function.html#云函数引入)
:::

## 编写并发布待调用云函数

比如,我们创建一个名为 `get-user-info` 的云函数,并编写如下代码:
Expand All @@ -32,10 +36,6 @@ export async function main(ctx: FunctionContext) {

## 调用已发布云函数

::: info
`cloud.invoke`方法已不推荐使用,可使用[引入云函数](/guide/function/use-function.html#云函数引入)
:::

`get-user-info` 云函数发布后, 我们可以在其他云函数调用该函数。

```typescript
Expand Down
20 changes: 16 additions & 4 deletions docs/guide/function/depend.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,25 @@ title: 依赖管理

应用开发过程中,通常有添加 `npm` 依赖的需求,`laf` 提供了在线可视化管理这些第三方包模块的方法, 用户可非常方便的进行搜索、安装、升级和卸载。

::: info
Laf云开发可安装来自 <https://www.npmjs.com/> 的依赖,如果所需依赖无法在该网站中找到,是无法安装的
:::

## 添加依赖

![](/doc-images/add-packages.png)
![add-packages](/doc-images/add-packages.png)

如上图所示,我们依次点击屏幕左下方的 `NPM 依赖`、 添加按钮, 搜索想要安装的包名(此处以 [moment](https://www.npmjs.com/package/moment) 为例),勾选后点击 `保存并重启` 按钮即可。

> 安装的持续时间会根据包的大小和网络情况而不同,请耐心等待完成。

![](/doc-images/package-list.png)
![package-list](/doc-images/package-list.png)

安装完成后用户可在界面左下方 `依赖管理` 中查看已安装的依赖和版本。

## 版本
## 依赖版本选择

![](/doc-images/select-package-version.png)
![select-package-version](/doc-images/select-package-version.png)

为保证用户应用稳定性,`Laf` 不会自动更新应用的 `Npm package` 版本。

Expand Down Expand Up @@ -52,3 +56,11 @@ export async function main(ctx: FunctionContext) {
"twoHoursLater": "2023-02-08 04:14:05"
}
```

## 切换已安装依赖版本

![change-package-version](/doc-images/change-package-version.png)

## 卸载已安装依赖版本

![delete-package](/doc-images/delete-package.png)
14 changes: 5 additions & 9 deletions docs/guide/function/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,18 @@ title: 在云函数中使用环境变量

# {{ $frontmatter.title }}


## 添加环境变量

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

![](/doc-images/add-env.png)


::: warning
请注意,更新环境变量需要重启当前应用以生效。
重启期间应用将无法正常提供服务,因此在重启之前,请确保应用已暂停业务请求。
:::

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

![](/doc-images/add-env.png)

## 使用环境变量

Expand All @@ -35,4 +32,3 @@ export async function main(ctx: FunctionContext) {
}

```

41 changes: 41 additions & 0 deletions docs/guide/function/logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: 云函数历史日志
---

# {{ $frontmatter.title }}

云函数的全部历史日志,全部都自动保存到了日志板块中,日志会保留7天

可根据请求ID `requestId` 和云函数名筛选

![function-log](/doc-images/function-log.png)

1、点击日志,切换到日志板块

2、可根据 `requestId` 和云函数名搜索指定日志

3、点击单个日志,可查看详细内容

## 手动清理日志

Laf云函数的运行日志都在一个隐藏的集合中:`__function_logs__`

所以我们可以通过云函数操作数据库的方法,清理日志

以下是清理全部日志的云函数写法:

::: danger
以下操作会删除全部历史日志,请谨慎操作
:::

```ts
import cloud from '@lafjs/cloud'

export async function main(ctx: FunctionContext) {
console.log('Hello World')
// 数据库,删除全部日志
const db = cloud.database();
const res = await db.collection('__function_logs__').remove({multi:true})
console.log(res)
}
```
8 changes: 5 additions & 3 deletions docs/guide/function/use-function.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@ exports.main = async function (ctx: FunctionContext) {

现可直接在云函数中引入另外一个云函数

::: info
被引入的云函数需要发布后,才可以被引入
:::

引入写法:

```js
Expand Down Expand Up @@ -220,7 +224,7 @@ export async function main(ctx: FunctionContext) {
通过`cloud.database()` 可以获取数据库对象,进而对数据库进行操作。

::: info
数据库 API 的详细操作方法可以参考 _云数据库_ 章节
数据库 API 的详细操作方法可以参考 _[云数据库](/guide/db/)_ 章节
:::

下面的例子可以获取数据库中的用户信息:
Expand All @@ -233,9 +237,7 @@ export async function main(ctx: FunctionContext) {
// 数据库操作
const db = cloud.database();
const ret = await db.collection("users").where({ username }).get();

console.log(ret);
return ret.data;
};
```

Expand Down
Loading