Update api docs

yaklang · Apr 19, 2024 · 9f7d5b1 · 9f7d5b1
1 parent 9e178c7
commit 9f7d5b1
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 7 deletions.
diff --git a/docs/api/db.md b/docs/api/db.md
@@ -41,6 +41,7 @@
 | [db.SaveYakitPlugin](#saveyakitplugin) ||
 | [db.SetKey](#setkey) ||
 | [db.SetProjectKey](#setprojectkey) ||
+| [db.YieldPayload](#yieldpayload) |YieldPayload means |
 | [db.YieldYakScriptAll](#yieldyakscriptall) ||
 
 
@@ -688,13 +689,13 @@
 
 #### 定义
 
-`SavePayload(group string, payloads []string) error`
+`SavePayload(group string, payloadRaw any) error`
 
 #### 参数
 |参数名|参数类型|参数解释|
 |:-----------|:---------- |:-----------|
 | group | `string` |   |
-| payloads | `[]string` |   |
+| payloadRaw | `any` |   |
 
 #### 返回值
 |返回值(顺序)|返回值类型|返回值解释|
@@ -828,6 +829,28 @@
 | r1 | `error` |   |
 
 
+### YieldPayload
+
+#### 详细描述
+YieldPayload means
+
+
+#### 定义
+
+`YieldPayload(raw any, extra ...any) chan string`
+
+#### 参数
+|参数名|参数类型|参数解释|
+|:-----------|:---------- |:-----------|
+| raw | `any` |   |
+| extra | `...any` |   |
+
+#### 返回值
+|返回值(顺序)|返回值类型|返回值解释|
+|:-----------|:---------- |:-----------|
+| r1 | `chan string` |   |
+
+
 ### YieldYakScriptAll
 
 #### 详细描述

diff --git a/docs/api/ssa.md b/docs/api/ssa.md
@@ -3,7 +3,7 @@
 |成员函数|函数描述/介绍|
 |:------|:--------|
 | [ssa.Parse](#parse) ||
-| [ssa.withDataBase](#withdatabase) |save to database, please set the program name |
+| [ssa.withDatabaseProgramName](#withdatabaseprogramname) |save to database, please set the program name |
 | [ssa.withExternLib](#withexternlib) ||
 | [ssa.withExternValue](#withexternvalue) ||
 | [ssa.withLanguage](#withlanguage) ||
@@ -32,15 +32,15 @@
 | r2 | `error` |   |
 
 
-### withDataBase
+### withDatabaseProgramName
 
 #### 详细描述
 save to database, please set the program name
 
 
 #### 定义
 
-`withDataBase(name string) Option`
+`withDatabaseProgramName(name string) Option`
 
 #### 参数
 |参数名|参数类型|参数解释|

diff --git a/docs/api/yakit.md b/docs/api/yakit.md
@@ -50,6 +50,7 @@
 | [yakit.SetProgress](#setprogress) ||
 | [yakit.SetProgressEx](#setprogressex) ||
 | [yakit.StatusCard](#statuscard) ||
+| [yakit.Stream](#stream) ||
 | [yakit.TableData](#tabledata) ||
 | [yakit.Text](#text) ||
 | [yakit.TextTabData](#texttabdata) ||
@@ -816,13 +817,13 @@
 
 #### 定义
 
-`SavePayload(group string, payloads []string) error`
+`SavePayload(group string, payloadRaw any) error`
 
 #### 参数
 |参数名|参数类型|参数解释|
 |:-----------|:---------- |:-----------|
 | group | `string` |   |
-| payloads | `[]string` |   |
+| payloadRaw | `any` |   |
 
 #### 返回值
 |返回值(顺序)|返回值类型|返回值解释|
@@ -940,6 +941,24 @@
 | r1 | `` |   |
 
 
+### Stream
+
+#### 详细描述
+
+
+#### 定义
+
+`Stream(streamType string, streamId string, stream io.Reader, extra ...any)`
+
+#### 参数
+|参数名|参数类型|参数解释|
+|:-----------|:---------- |:-----------|
+| streamType | `string` |   |
+| streamId | `string` |   |
+| stream | `io.Reader` |   |
+| extra | `...any` |   |
+
+
 ### TableData
 
 #### 详细描述