Austin/docs
1
0
Fork 0
mirror of https://github.com/gkd-kit/docs.git synced 2024-11-16 16:22:20 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: api desc

Browse Source
This commit is contained in:
lisonge 2024-02-07 20:49:02 +08:00
parent abd32424b6
commit a7d8ba1ef6
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
api/src/index.ts
View File

@ -89,6 +89,9 @@ export interface RawApp {
* 全局规则组 * 全局规则组
*/ */
export interface RawGlobalGroup extends RawGroupProps, RawGlobalRuleProps { export interface RawGlobalGroup extends RawGroupProps, RawGlobalRuleProps {
/**
* 全局规则组的规则列表
*/
rules: RawGlobalRule[]; rules: RawGlobalRule[];
} }
@ -132,6 +135,8 @@ export interface RawAppRule extends RawRuleProps, RawAppRuleProps {}
*/ */
export interface RawAppGroup extends RawGroupProps, RawAppRuleProps { export interface RawAppGroup extends RawGroupProps, RawAppRuleProps {
/** /**
* 应用规则组的规则列表, 支持多种类型
*
* string => { matches: string } * string => { matches: string }
* *
* string[] => { matches: string }[] * string[] => { matches: string }[]
@ -434,8 +439,6 @@ export interface RawGroupProps extends RawCommonProps {
* *
*/ */
scopeKeys?: IArray<Integer>; scopeKeys?: IArray<Integer>;
// rules: RawRuleProps[];
} }
/** /**