Skip to content

Commit

Permalink
feat: 用户变量描述
Browse files Browse the repository at this point in the history
  • Loading branch information
maotoumao committed Nov 25, 2023
1 parent 044bb49 commit 9496302
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/plugin/protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,19 @@ module.exports = {

:::

### 用户变量 (userVariables) <Badge type="tip" text="可选" /> <Badge type="warning" text="安卓版 >0.1.2-alpha.0" />

用户变量,用来定义一些在插件中会使用到的,由用户定义的变量。

该字段值是一个数组,数组的每一项是个对象,其键值如下表:

| 键名 | 值类型 | 说明 |
| :----------------: | :--------: | :-----------------------------: |
| `key` | `string` | 该变量的键 |
| `title` | `string` | 该变量展示在软件面板中的名称,可选 |

定义后,插件中可通过 `env.getUserVariables()` 获取用户输入的值。

## 插件函数

> 在开始之前,你也可以先看一下 [typescript 文档](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#functions) 关于函数类型的部分。
Expand Down

0 comments on commit 9496302

Please sign in to comment.