Update api docs

yaklang · Jul 12, 2024 · 52bb906 · 52bb906
1 parent 3ea911a
commit 52bb906
Show file tree

Hide file tree

Showing 13 changed files with 192 additions and 692 deletions.
diff --git a/docs/api/crawlerx.md b/docs/api/crawlerx.md
@@ -3,12 +3,12 @@
 |实例名|实例描述|
 |:------|:--------|
 HighRepeatLevel|(crawlerx.repeatLevel) 3|
+LowRepeatLevel|(crawlerx.repeatLevel) 1|
+MediumRepeatLevel|(crawlerx.repeatLevel) 2|
 ExtremeRepeatLevel|(crawlerx.repeatLevel) 4|
 AllDomainScan|(crawlerx.scanRangeLevel) 0|
-LowRepeatLevel|(crawlerx.repeatLevel) 1|
-SubMenuScan|(crawlerx.scanRangeLevel) 1|
 UnLimitRepeat|(crawlerx.repeatLevel) 0|
-MediumRepeatLevel|(crawlerx.repeatLevel) 2|
+SubMenuScan|(crawlerx.scanRangeLevel) 1|
 
 |函数名|函数描述/介绍|
 |:------|:--------|

diff --git a/docs/api/db.md b/docs/api/db.md
@@ -2,12 +2,12 @@
 
 |实例名|实例描述|
 |:------|:--------|
-YAKIT_PLUGIN_TYPE_PORTSCAN|(string) "port-scan"|
-YAKIT_PLUGIN_TYPE_PACKET_HACK|(string) "packet-hack"|
 YAKIT_PLUGIN_TYPE_NUCLEI|(string) "nuclei"|
-YAKIT_PLUGIN_TYPE_MITM|(string) "mitm"|
-YAKIT_PLUGIN_TYPE_YAK|(string) "yak"|
 YAKIT_PLUGIN_TYPE_CODEC|(string) "codec"|
+YAKIT_PLUGIN_TYPE_PACKET_HACK|(string) "packet-hack"|
+YAKIT_PLUGIN_TYPE_YAK|(string) "yak"|
+YAKIT_PLUGIN_TYPE_MITM|(string) "mitm"|
+YAKIT_PLUGIN_TYPE_PORTSCAN|(string) "port-scan"|
 
 |函数名|函数描述/介绍|
 |:------|:--------|

diff --git a/docs/api/file.md b/docs/api/file.md
@@ -2,15 +2,15 @@
 
 |实例名|实例描述|
 |:------|:--------|
-O_TRUNC|(int) 512|
-O_APPEND|(int) 1024|
 O_CREATE|(int) 64|
+O_APPEND|(int) 1024|
 SEPARATOR|(string) "/"|
+O_EXCL|(int) 128|
 O_RDONLY|(int) 0|
-O_WRONLY|(int) 1|
+O_TRUNC|(int) 512|
 O_SYNC|(int) 1052672|
+O_WRONLY|(int) 1|
 O_RDWR|(int) 2|
-O_EXCL|(int) 128|
 
 |函数名|函数描述/介绍|
 |:------|:--------|

diff --git a/docs/api/io.md b/docs/api/io.md
@@ -2,8 +2,8 @@
 
 |实例名|实例描述|
 |:------|:--------|
-EOF|(errors.errorString) &errors.errorString{s: "EOF"}|
 Discard|(io.discard) io.discard{}|
+EOF|(errors.errorString) &errors.errorString{s: "EOF"}|
 
 |函数名|函数描述/介绍|
 |:------|:--------|

diff --git a/docs/api/js.md b/docs/api/js.md
@@ -2,12 +2,12 @@
 
 |实例名|实例描述|
 |:------|:--------|
-NullValue|(github.com/dop251/goja.valueNull) null|
+TrueValue|(goja.valueBool) true|
+UndefinedValue|(github.com/dop251/goja.valueUndefined) undefined|
 NaNValue|(goja.valueFloat) NaN|
-FalseValue|(goja.valueBool) false|
 PoweredBy|(string) "github.com/dop251/goja"|
-UndefinedValue|(github.com/dop251/goja.valueUndefined) undefined|
-TrueValue|(goja.valueBool) true|
+FalseValue|(goja.valueBool) false|
+NullValue|(github.com/dop251/goja.valueNull) null|
 
 |函数名|函数描述/介绍|
 |:------|:--------|

diff --git a/docs/api/jwt.md b/docs/api/jwt.md
@@ -2,19 +2,19 @@
 
 |实例名|实例描述|
 |:------|:--------|
-ALG_ES384|(string) "ES384"|
-ALG_RS256|(string) "RS256"|
+ALG_PS256|(string) "PS256"|
 ALG_PS512|(string) "PS512"|
-ALG_HS384|(string) "HS384"|
+ALG_RS256|(string) "RS256"|
+ALG_NONE|(string) "None"|
+ALG_ES384|(string) "ES384"|
+ALG_RS512|(string) "RS512"|
+ALG_PS384|(string) "PS384"|
 ALG_RS384|(string) "RS384"|
-ALG_HS512|(string) "HS512"|
-ALG_PS256|(string) "PS256"|
 ALG_ES256|(string) "ES256"|
+ALG_HS512|(string) "HS512"|
+ALG_HS384|(string) "HS384"|
 ALG_HS256|(string) "HS256"|
 ALG_ES512|(string) "ES512"|
-ALG_RS512|(string) "RS512"|
-ALG_NONE|(string) "None"|
-ALG_PS384|(string) "PS384"|
 
 |函数名|函数描述/介绍|
 |:------|:--------|

diff --git a/docs/api/math.md b/docs/api/math.md
@@ -2,13 +2,13 @@
 
 |实例名|实例描述|
 |:------|:--------|
-Ln10|(float64) 2.302585|
+Sqrt2|(float64) 1.414214|
+Ln2|(float64) 0.693147|
 E|(float64) 2.718282|
-Pi|(float64) 3.141593|
 SqrtPi|(float64) 1.772454|
-Ln2|(float64) 0.693147|
+Pi|(float64) 3.141593|
 SqrtE|(float64) 1.648721|
-Sqrt2|(float64) 1.414214|
+Ln10|(float64) 2.302585|
 
 |函数名|函数描述/介绍|
 |:------|:--------|

diff --git a/docs/api/os.md b/docs/api/os.md
@@ -2,13 +2,13 @@
 
 |实例名|实例描述|
 |:------|:--------|
-Stderr|(os.File) &os.File{file: &os.file{pfd: poll.FD{fdmu: poll.fdMutex{state: 0, rsema: 0, wsema: 0}, Sysfd: 2, SysFile: poll.SysFile{iovecs: (*[]syscall.Iovec)(nil)}, pd: poll.pollDesc{runtimeCtx: 0}, csema: 0, isBlocking: 1, IsStream: true, ZeroReadIsEOF: true, isFile: true}, name: "/dev/stderr", dirinfo: <Already printed>, nonblock: false, stdoutOrErr: true, appendMode: false}}|
-ARCH|(string) "amd64"|
 OS|(string) "linux"|
+Stderr|(os.File) &os.File{file: &os.file{pfd: poll.FD{fdmu: poll.fdMutex{state: 0, rsema: 0, wsema: 0}, Sysfd: 2, SysFile: poll.SysFile{iovecs: (*[]syscall.Iovec)(nil)}, pd: poll.pollDesc{runtimeCtx: 0}, csema: 0, isBlocking: 1, IsStream: true, ZeroReadIsEOF: true, isFile: true}, name: "/dev/stderr", dirinfo: <Already printed>, nonblock: false, stdoutOrErr: true, appendMode: false}}|
 IsPrivileged|(bool) false|
-Stdin|(os.File) &os.File{file: &os.file{pfd: poll.FD{fdmu: poll.fdMutex{state: 0, rsema: 0, wsema: 0}, Sysfd: 0, SysFile: poll.SysFile{iovecs: (*[]syscall.Iovec)(nil)}, pd: poll.pollDesc{runtimeCtx: 0}, csema: 0, isBlocking: 1, IsStream: true, ZeroReadIsEOF: true, isFile: true}, name: "/dev/stdin", dirinfo: <Already printed>, nonblock: false, stdoutOrErr: false, appendMode: false}}|
 Stdout|(os.File) &os.File{file: &os.file{pfd: poll.FD{fdmu: poll.fdMutex{state: 0, rsema: 0, wsema: 0}, Sysfd: 1, SysFile: poll.SysFile{iovecs: (*[]syscall.Iovec)(nil)}, pd: poll.pollDesc{runtimeCtx: 0}, csema: 0, isBlocking: 1, IsStream: true, ZeroReadIsEOF: true, isFile: true}, name: "/dev/stdout", dirinfo: <Already printed>, nonblock: false, stdoutOrErr: true, appendMode: false}}|
-Args|([]string) []string{"/tmp/go-build223921850/b001/exe/generate_web_doc", "web_doc/"}|
+Args|([]string) []string{"/tmp/go-build1952082855/b001/exe/generate_web_doc", "web_doc/"}|
+ARCH|(string) "amd64"|
+Stdin|(os.File) &os.File{file: &os.file{pfd: poll.FD{fdmu: poll.fdMutex{state: 0, rsema: 0, wsema: 0}, Sysfd: 0, SysFile: poll.SysFile{iovecs: (*[]syscall.Iovec)(nil)}, pd: poll.pollDesc{runtimeCtx: 0}, csema: 0, isBlocking: 1, IsStream: true, ZeroReadIsEOF: true, isFile: true}, name: "/dev/stdin", dirinfo: <Already printed>, nonblock: false, stdoutOrErr: false, appendMode: false}}|
 
 |函数名|函数描述/介绍|
 |:------|:--------|

diff --git a/docs/api/pcapx.md b/docs/api/pcapx.md
@@ -2,72 +2,72 @@
 
 |实例名|实例描述|
 |:------|:--------|
-ICMP_CODE_UNREACH_HOST|(int) 1|
-TCP_FLAG_NS|(int) 256|
-TCP_FLAG_RST|(int) 4|
-TCP_FLAG_ACK|(int) 16|
-ICMP_CODE_UNREACH_HOST_UNKNOWN|(int) 7|
+ICMP_CODE_PARAM_PROBLEM_MISSING_OPTION|(int) 1|
+IPV4_FLAG_MORE_FRAGMENT|(int) 1|
+ICMP_CODE_TIME_EXCEEDED_FRAG_REASS|(int) 1|
+ICMP_CODE_UNREACH_PROTOCOL|(int) 2|
+ICMP_CODE_UNREACH_COMM_ADMIN|(int) 13|
+IPV4_PROTOCOL_ESP|(int) 50|
+IPV4_PROTOCOL_ETHERIP|(int) 97|
+ICMP_TYPE_ROUTER_ADVERTISEMENT|(int) 9|
+ICMP_TYPE_ECHO_REQUEST|(int) 8|
+IPV4_PROTOCOL_SCTP|(int) 132|
+TCP_FLAG_SYN|(int) 2|
 ICMP_CODE_UNREACH_SRC_ROUTE_FAIL|(int) 5|
-IPV4_PROTOCOL_UDPLITE|(int) 136|
+ICMP_CODE_UNREACH_PRECEDENCE_CUTOFF|(int) 15|
+IPV4_PROTOCOL_ICMP|(int) 1|
+ICMP_TYPE_PARAM_PROBLEM|(int) 12|
+ICMP_CODE_REDIRECT_HOST|(int) 1|
+ICMP_TYPE_INFO_REQUEST|(int) 15|
+TCP_FLAG_PSH|(int) 8|
+ICMP_CODE_REDIRECT_NET|(int) 0|
+ICMP_CODE_UNREACH_NET|(int) 0|
+ICMP_CODE_REDIRECT_TOS_NET|(int) 11|
+ICMP_CODE_UNREACH_NET_TOS|(int) 11|
+ICMP_TYPE_TIME_EXCEEDED|(int) 11|
 ICMP_CODE_UNREACH_HOST_ADMIN|(int) 10|
-ICMP_TYPE_ECHO_REQUEST|(int) 8|
-IPV4_PROTOCOL_GRE|(int) 47|
-ICMP_TYPE_ROUTER_SOLICITATION|(int) 10|
-IPV4_PROTOCOL_VRRP|(int) 112|
-ICMP_CODE_UNREACH_COMM_ADMIN|(int) 13|
+TCP_FLAG_FIN|(int) 1|
+TCP_FLAG_RST|(int) 4|
+ICMP_TYPE_ADDRESS_MASK_REQUEST|(int) 17|
+ICMP_CODE_UNREACH_HOST_UNKNOWN|(int) 7|
 ICMP_CODE_UNREACH_FRAGMENTATION_NEEDED|(int) 4|
-IPV4_PROTOCOL_ESP|(int) 50|
 ICMP_CODE_REDIRECT_TOS_HOST|(int) 12|
-ICMP_CODE_REDIRECT_NET|(int) 0|
-ICMP_CODE_UNREACH_PRECEDENCE_CUTOFF|(int) 15|
-ICMP_TYPE_DEST_UNREACH|(int) 3|
+ICMP_TYPE_INFO_REPLY|(int) 16|
+IPV4_PROTOCOL_GRE|(int) 47|
+ICMP_CODE_UNREACH_NET_UNKNOWN|(int) 6|
+IPV4_FLAG_DONT_FRAGMENT|(int) 2|
+IPV4_PROTOCOL_TCP|(int) 6|
+TCP_FLAG_ECE|(int) 64|
+ICMP_CODE_UNREACH_PORT|(int) 3|
 ICMP_CODE_UNREACH_HOST_TOS|(int) 12|
+IPV4_FLAG_EVIL_BIT|(int) 4|
+ICMP_CODE_UNREACH_NET_ADMIN|(int) 9|
+ICMP_TYPE_TIMESTAMP|(int) 13|
+TCP_FLAG_ACK|(int) 16|
 ICMP_TYPE_ADDRESS_MASK_REPLY|(int) 18|
-ICMP_TYPE_ROUTER_ADVERTISEMENT|(int) 9|
-ICMP_CODE_UNREACH_SRC_ISOLATED|(int) 8|
-ICMP_CODE_UNREACH_NET_TOS|(int) 11|
-ICMP_TYPE_INFO_REQUEST|(int) 15|
-IPV4_PROTOCOL_IGMP|(int) 2|
-IPV4_FLAG_DONT_FRAGMENT|(int) 2|
+ICMP_CODE_UNREACH_HOST|(int) 1|
 IPV4_PROTOCOL_AH|(int) 51|
-ICMP_CODE_REDIRECT_TOS_NET|(int) 11|
-IPV4_PROTOCOL_UDP|(int) 17|
-ICMP_TYPE_TIMESTAMP|(int) 13|
-IPV4_PROTOCOL_TCP|(int) 6|
+ICMP_TYPE_ROUTER_SOLICITATION|(int) 10|
+ICMP_TYPE_SRC_QUENCH|(int) 4|
 ICMP_CODE_UNREACH_HOST_PRECEDENCE|(int) 14|
-TCP_FLAG_URG|(int) 32|
-ICMP_CODE_UNREACH_PROTOCOL|(int) 2|
-ICMP_TYPE_TIMESTAMP_REPLY|(int) 14|
-TCP_FLAG_CWR|(int) 128|
-IPV4_PROTOCOL_IPIP|(int) 94|
-IPV4_FLAG_MORE_FRAGMENT|(int) 1|
+IPV4_PROTOCOL_UDP|(int) 17|
 ICMP_CODE_PARAM_PROBLEM_POINTER_INDICATES_ERROR|(int) 0|
-ICMP_CODE_PARAM_PROBLEM_BAD_LENGTH|(int) 2|
-ICMP_TYPE_ADDRESS_MASK_REQUEST|(int) 17|
-ICMP_CODE_TIME_EXCEEDED_TTL|(int) 0|
-IPV4_PROTOCOL_OSPF|(int) 89|
-ICMP_CODE_UNREACH_PORT|(int) 3|
-ICMP_TYPE_SRC_QUENCH|(int) 4|
-IPV4_PROTOCOL_SCTP|(int) 132|
-IPV4_PROTOCOL_ETHERIP|(int) 97|
-ICMP_CODE_UNREACH_NET_UNKNOWN|(int) 6|
-IPV4_PROTOCOL_MPLSINIP|(int) 137|
-ICMP_CODE_REDIRECT_HOST|(int) 1|
-ICMP_TYPE_PARAM_PROBLEM|(int) 12|
 ICMP_TYPE_ECHO_REPLY|(int) 0|
-IPV4_FLAG_EVIL_BIT|(int) 4|
-TCP_FLAG_ECE|(int) 64|
-TCP_FLAG_PSH|(int) 8|
-IPV4_PROTOCOL_ICMP|(int) 1|
-ICMP_CODE_PARAM_PROBLEM_MISSING_OPTION|(int) 1|
-ICMP_CODE_UNREACH_NET_ADMIN|(int) 9|
+IPV4_PROTOCOL_MPLSINIP|(int) 137|
+ICMP_CODE_PARAM_PROBLEM_BAD_LENGTH|(int) 2|
 ICMP_TYPE_REDIRECT|(int) 5|
-ICMP_CODE_UNREACH_NET|(int) 0|
-ICMP_TYPE_INFO_REPLY|(int) 16|
-ICMP_CODE_TIME_EXCEEDED_FRAG_REASS|(int) 1|
-ICMP_TYPE_TIME_EXCEEDED|(int) 11|
-TCP_FLAG_FIN|(int) 1|
-TCP_FLAG_SYN|(int) 2|
+TCP_FLAG_CWR|(int) 128|
+ICMP_TYPE_TIMESTAMP_REPLY|(int) 14|
+TCP_FLAG_URG|(int) 32|
+IPV4_PROTOCOL_IPIP|(int) 94|
+IPV4_PROTOCOL_IGMP|(int) 2|
+TCP_FLAG_NS|(int) 256|
+IPV4_PROTOCOL_OSPF|(int) 89|
+ICMP_CODE_UNREACH_SRC_ISOLATED|(int) 8|
+ICMP_CODE_TIME_EXCEEDED_TTL|(int) 0|
+IPV4_PROTOCOL_VRRP|(int) 112|
+IPV4_PROTOCOL_UDPLITE|(int) 136|
+ICMP_TYPE_DEST_UNREACH|(int) 3|
 
 |函数名|函数描述/介绍|
 |:------|:--------|