Skip to content

Commit

Permalink
Update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Aug 14, 2024
1 parent 8c92556 commit dc2413b
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/api/simulator.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ htmlChangeMode|(simulator.loginDetectMode) 1|
leaklessDefault|(simulator.LeaklessMode) 0|
leaklessOff|(simulator.LeaklessMode) -1|
leaklessOn|(simulator.LeaklessMode) 1|
simple|(map[string]interface {}) map[string]interface {}{"bodyModifyTarget": "body", "bodyReplaceTarget": "bodyReplace", "createBrowser": (func(...simple.BrowserConfigOpt) *simple.VBrowser)(0x26d99e0), "headersModifyTarget": "headers", "headless": (func(bool) simple.BrowserConfigOpt)(0x26d9420), "hostModifyTarget": "host", "noSandBox": (func(bool) simple.BrowserConfigOpt)(0x26d93a0), "proxy": (func(string, ...string) simple.BrowserConfigOpt)(0x26d91e0), "requestModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x26d9740), "responseModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x26d94a0), "wsAddress": (func(string) simple.BrowserConfigOpt)(0x26d9100)}|
simple|(map[string]interface {}) map[string]interface {}{"bodyModifyTarget": "body", "bodyReplaceTarget": "bodyReplace", "createBrowser": (func(...simple.BrowserConfigOpt) *simple.VBrowser)(0x26da620), "headersModifyTarget": "headers", "headless": (func(bool) simple.BrowserConfigOpt)(0x26da060), "hostModifyTarget": "host", "noSandBox": (func(bool) simple.BrowserConfigOpt)(0x26d9fe0), "proxy": (func(string, ...string) simple.BrowserConfigOpt)(0x26d9e20), "requestModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x26da380), "responseModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x26da0e0), "wsAddress": (func(string) simple.BrowserConfigOpt)(0x26d9d40)}|
urlChangeMode|(simulator.loginDetectMode) 0|

|函数名|函数描述/介绍|
Expand Down
73 changes: 68 additions & 5 deletions docs/api/ssa.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,16 @@ Yak|(consts.Language) "yak"|
|:------|:--------|
| [ssa.Parse](#parse) ||
| [ssa.ParseLocalProject](#parselocalproject) ||
| [ssa.withDatabaseProgramName](#withdatabaseprogramname) |save to database, please set the program name |
| [ssa.withDatabasePath](#withdatabasepath) ||
| [ssa.withDescription](#withdescription) ||
| [ssa.withEntryFile](#withentryfile) ||
| [ssa.withExternLib](#withexternlib) ||
| [ssa.withExternValue](#withexternvalue) ||
| [ssa.withLanguage](#withlanguage) ||
| [ssa.withProcess](#withprocess) ||
| [ssa.withProgramName](#withprogramname) |save to database, please set the program name |
| [ssa.withReCompile](#withrecompile) ||
| [ssa.withSaveToProfile](#withsavetoprofile) ||


## 函数定义
Expand Down Expand Up @@ -65,20 +68,39 @@ Yak|(consts.Language) "yak"|
| r2 | `error` | |


### withDatabaseProgramName
### withDatabasePath

#### 详细描述
save to database, please set the program name


#### 定义

`withDatabaseProgramName(name string) Option`
`withDatabasePath(path string) Option`

#### 参数
|参数名|参数类型|参数解释|
|:-----------|:---------- |:-----------|
| name | `string` | |
| path | `string` | |

#### 返回值
|返回值(顺序)|返回值类型|返回值解释|
|:-----------|:---------- |:-----------|
| r1 | `Option` | |


### withDescription

#### 详细描述


#### 定义

`withDescription(desc string) Option`

#### 参数
|参数名|参数类型|参数解释|
|:-----------|:---------- |:-----------|
| desc | `string` | |

#### 返回值
|返回值(顺序)|返回值类型|返回值解释|
Expand Down Expand Up @@ -187,6 +209,27 @@ save to database, please set the program name
| r1 | `Option` | |


### withProgramName

#### 详细描述
save to database, please set the program name


#### 定义

`withProgramName(name string) Option`

#### 参数
|参数名|参数类型|参数解释|
|:-----------|:---------- |:-----------|
| name | `string` | |

#### 返回值
|返回值(顺序)|返回值类型|返回值解释|
|:-----------|:---------- |:-----------|
| r1 | `Option` | |


### withReCompile

#### 详细描述
Expand All @@ -207,3 +250,23 @@ save to database, please set the program name
| r1 | `Option` | |


### withSaveToProfile

#### 详细描述


#### 定义

`withSaveToProfile(b ...bool) Option`

#### 参数
|参数名|参数类型|参数解释|
|:-----------|:---------- |:-----------|
| b | `...bool` | |

#### 返回值
|返回值(顺序)|返回值类型|返回值解释|
|:-----------|:---------- |:-----------|
| r1 | `Option` | |


0 comments on commit dc2413b

Please sign in to comment.