Skip to content

Commit

Permalink
Update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Jul 3, 2024
1 parent a092bea commit 45c59c2
Show file tree
Hide file tree
Showing 92 changed files with 439 additions and 92 deletions.
2 changes: 1 addition & 1 deletion docs/api/ai.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ai

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [ai.Chat](#chat) ||
| [ai.ChatGLM](#chatglm) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/bin.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# bin

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [bin.Read](#read) ||
| [bin.toBool](#tobool) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/bot.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# bot

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [bot.FromEnv](#fromenv) ||
| [bot.New](#new) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/brute.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# brute

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [brute.GetAvailableBruteTypes](#getavailablebrutetypes) ||
| [brute.GetPasswordListFromBruteType](#getpasswordlistfrombrutetype) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/bufio.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# bufio

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [bufio.NewBuffer](#newbuffer) |NewBuffer 创建一个新的 Buffer 结构体引用，其帮助我们处理字符串 Buffer 也实现了 Reader 和 Writer 接口 常用的 Buffer 方法有：Bytes, String, Read, Write, WriteString, WriteByte, Reset |
| [bufio.NewReadWriter](#newreadwriter) |NewReadWriter 根据传入的 Reader 和 Writer 创建一个新的 BufioReadWriter 结构体引用 BufioReadWriter 可以同时调用 BufioReader 和 BufioWriter 的方法 |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/cli.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# cli

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [cli.Args](#args) ||
| [cli.Bool](#bool) |Bool 获取对应名称的命令行参数，并将其转换为 bool 类型返回 |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/codec.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# codec

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [codec.AESCBCDecrypt](#aescbcdecrypt) ||
| [codec.AESCBCDecryptWithPKCS7Padding](#aescbcdecryptwithpkcs7padding) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/context.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# context

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [context.Background](#background) ||
| [context.New](#new) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/crawler.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# crawler

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [crawler.RequestsFromFlow](#requestsfromflow) |RequestsFromFlow 尝试从一次请求与响应中爬取出所有可能的请求，返回所有可能请求的原始报文与错误 |
| [crawler.Start](#start) |Start 启动爬虫爬取某个URL，它还可以接收零个到多个选项函数，用于影响爬取行为 返回一个Req结构体引用管道与错误 |
Expand Down
12 changes: 11 additions & 1 deletion docs/api/crawlerx.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# crawlerx

|成员函数|函数描述/介绍|
|实例名|实例描述|
|:------|:--------|
MediumRepeatLevel|(crawlerx.repeatLevel) 2|
LowRepeatLevel|(crawlerx.repeatLevel) 1|
ExtremeRepeatLevel|(crawlerx.repeatLevel) 4|
HighRepeatLevel|(crawlerx.repeatLevel) 3|
AllDomainScan|(crawlerx.scanRangeLevel) 0|
UnLimitRepeat|(crawlerx.repeatLevel) 0|
SubMenuScan|(crawlerx.scanRangeLevel) 1|

|函数名|函数描述/介绍|
|:------|:--------|
| [crawlerx.PageScreenShot](#pagescreenshot) ||
| [crawlerx.StartCrawler](#startcrawler) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/csrf.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# csrf

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [csrf.Generate](#generate) |Generate 根据传入的原始请求报文生成跨站请求伪造(CSRF)类型的漏洞验证(POC)，返回生成的POC HTML字符串与错误 |
| [csrf.https](#https) |https 手动设置请求报文是否为HTTPS类型 |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/cve.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# cve

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [cve.Download](#download) |DownLoad 从NVD下载CVE json数据到本地 |
| [cve.GetCVE](#getcve) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/cwe.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# cwe

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [cwe.Get](#get) ||

Expand Down
11 changes: 10 additions & 1 deletion docs/api/db.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# db

|成员函数|函数描述/介绍|
|实例名|实例描述|
|:------|:--------|
YAKIT_PLUGIN_TYPE_NUCLEI|(string) "nuclei"|
YAKIT_PLUGIN_TYPE_PACKET_HACK|(string) "packet-hack"|
YAKIT_PLUGIN_TYPE_CODEC|(string) "codec"|
YAKIT_PLUGIN_TYPE_MITM|(string) "mitm"|
YAKIT_PLUGIN_TYPE_YAK|(string) "yak"|
YAKIT_PLUGIN_TYPE_PORTSCAN|(string) "port-scan"|

|函数名|函数描述/介绍|
|:------|:--------|
| [db.CreateTemporaryYakScript](#createtemporaryyakscript) ||
| [db.DelKey](#delkey) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/dictutil.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# dictutil

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [dictutil.Mix](#mix) ||

Expand Down
2 changes: 1 addition & 1 deletion docs/api/dns.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# dns

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [dns.QuertAxfr](#quertaxfr) ||
| [dns.QueryIP](#queryip) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/dnslog.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# dnslog

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [dnslog.LookupFirst](#lookupfirst) ||
| [dnslog.NewCustomDNSLog](#newcustomdnslog) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/dyn.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# dyn

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [dyn.Eval](#eval) ||
| [dyn.Import](#import) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/env.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# env

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [env.Get](#get) |Get 获取对应键名的环境变量值 ! 已弃用，可以使用 `os.Getenv` 代替 |
| [env.Set](#set) |Set 设置对应键名的环境变量值 ! 已弃用，可以使用 `os.Setenv` 代替 |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/exec.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# exec

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [exec.CheckCrash](#checkcrash) ||
| [exec.Command](#command) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/facades.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# facades

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [facades.NewFacadeServer](#newfacadeserver) ||
| [facades.Serve](#serve) ||
Expand Down
14 changes: 13 additions & 1 deletion docs/api/file.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# file

|成员函数|函数描述/介绍|
|实例名|实例描述|
|:------|:--------|
O_APPEND|(int) 1024|
O_RDWR|(int) 2|
O_SYNC|(int) 1052672|
O_CREATE|(int) 64|
O_WRONLY|(int) 1|
O_EXCL|(int) 128|
SEPARATOR|(string) "/"|
O_TRUNC|(int) 512|
O_RDONLY|(int) 0|

|函数名|函数描述/介绍|
|:------|:--------|
| [file.Abs](#abs) |Abs 返回一个路径的绝对路径 |
| [file.Cat](#cat) |Cat 模拟 unix 命令 cat，打印文件内容到标准输出 |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/filesys.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# filesys

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [filesys.Recursive](#recursive) |Recursive recursively walk through the file system raw: the root path opts: options return: error |
| [filesys.dir](#dir) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/finscan.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# finscan

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [finscan.Scan](#scan) ||
| [finscan.concurrent](#concurrent) |设置 FIN 扫描的并发可以有效控制精准度 |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/fuzz.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# fuzz

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [fuzz.FuzzCalcExpr](#fuzzcalcexpr) ||
| [fuzz.FuzzCalcExprInt32Safe](#fuzzcalcexprint32safe) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/git.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# git

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [git.Checkout](#checkout) |Checkout 用于指定一个本地仓库，切换其分支或者恢复工作树的文件，这种行为称之为检出(checkout)，它还可以接收零个到多个选项函数，用于影响检出行为 |
| [git.Clone](#clone) |Clone 用于克隆远程仓库并存储到本地路径中，它还可以接收零个到多个选项函数，用于影响克隆行为 |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/gzip.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# gzip

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [gzip.Compress](#compress) ||
| [gzip.Decompress](#decompress) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/hids.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# hids

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [hids.CPUAverage](#cpuaverage) |CPUAverage 获取当前系统的 CPU 使用率平均值 |
| [hids.CPUAverageCallback](#cpuaveragecallback) |CPUPercentCallback 当 CPU 使用率平均值发生变化时，调用 callback 函数 |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/hook.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# hook

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [hook.CallYakitPluginFunc](#callyakitpluginfunc) ||
| [hook.LoadYakitPlugin](#loadyakitplugin) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/http.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# http

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [http.Do](#do) |Do 根据构造好的请求结构体引用发送请求，返回响应结构体引用与错误 ! 已弃用 |
| [http.ExtractFaviconURL](#extractfaviconurl) |ExtractFaviconURL will receive a site url and html content return the favicon url |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/httpool.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# httpool

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [httpool.Pool](#pool) ||
| [httpool.connPool](#connpool) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/httpserver.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# httpserver

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [httpserver.LocalFileSystemServe](#localfilesystemserve) |LocalFileSystemServe 根据给定的 host 和 port 启动一个 http 服务用于访问本地文件系统 第一个参数为监听主机，第二个参数为监听端口，第三个参数为访问路径前缀，第四个参数为本地文件系统路径，接下来可以接收零个到多个选项函数，用于设置上下文，回调函数等 |
| [httpserver.Serve](#serve) |Serve 根据给定的 host 和 port 启动一个 http 服务，第一个参数为监听主机，第二个参数为监听端口，接下来可以接收零个到多个选项函数，用于设置上下文，回调函数等 |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/iiop.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# iiop

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [iiop.BindPayload](#bindpayload) ||
| [iiop.InvokePayload](#invokepayload) ||
Expand Down
7 changes: 6 additions & 1 deletion docs/api/io.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# io

|成员函数|函数描述/介绍|
|实例名|实例描述|
|:------|:--------|
Discard|(io.discard) io.discard{}|
EOF|(errors.errorString) &errors.errorString{s: "EOF"}|

|函数名|函数描述/介绍|
|:------|:--------|
| [io.Copy](#copy) |Copy 将 reader 中的数据拷贝到 writer 中，直到读取到 EOF 或者发生错误，返回拷贝的字节数和错误 |
| [io.CopyN](#copyn) |CopyN 将 reader 中的数据拷贝到 writer 中，直到读取到 EOF 或者拷贝了 n 个字节，返回拷贝的字节数和错误 |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/ja3.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ja3

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [ja3.GetTransportByClientHelloSpec](#gettransportbyclienthellospec) ||
| [ja3.ParseJA3](#parseja3) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/java.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# java

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [java.FromJson](#fromjson) ||
| [java.MarshalJavaObjects](#marshaljavaobjects) ||
Expand Down
11 changes: 10 additions & 1 deletion docs/api/js.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# js

|成员函数|函数描述/介绍|
|实例名|实例描述|
|:------|:--------|
NullValue|(github.com/dop251/goja.valueNull) null|
FalseValue|(goja.valueBool) false|
PoweredBy|(string) "github.com/dop251/goja"|
UndefinedValue|(github.com/dop251/goja.valueUndefined) undefined|
TrueValue|(goja.valueBool) true|
NaNValue|(goja.valueFloat) NaN|

|函数名|函数描述/介绍|
|:------|:--------|
| [.](#) ||
| [js.ASTWalk](#astwalk) |ASTWalk 对传入的JS代码进行AST遍历，返回遍历后的结果(包含字面量，标识符，语法错误)和错误 |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/json.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# json

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [json.ExtractJSON](#extractjson) ||
| [json.ExtractJSONEx](#extractjsonex) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/judge.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# judge

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [judge.CompareHTTPResponse](#comparehttpresponse) ||
| [judge.CompareRaw](#compareraw) ||
Expand Down
18 changes: 17 additions & 1 deletion docs/api/jwt.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
# jwt

|成员函数|函数描述/介绍|
|实例名|实例描述|
|:------|:--------|
ALG_PS512|(string) "PS512"|
ALG_HS384|(string) "HS384"|
ALG_NONE|(string) "None"|
ALG_PS256|(string) "PS256"|
ALG_RS512|(string) "RS512"|
ALG_RS256|(string) "RS256"|
ALG_ES384|(string) "ES384"|
ALG_PS384|(string) "PS384"|
ALG_HS256|(string) "HS256"|
ALG_HS512|(string) "HS512"|
ALG_ES256|(string) "ES256"|
ALG_RS384|(string) "RS384"|
ALG_ES512|(string) "ES512"|

|函数名|函数描述/介绍|
|:------|:--------|
| [jwt.AllAlgs](#allalgs) ||
| [jwt.JWSGenerate](#jwsgenerate) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/ldap.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ldap

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [ldap.Login](#login) ||
| [ldap.password](#password) ||
Expand Down
2 changes: 1 addition & 1 deletion docs/api/log.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# log

|成员函数|函数描述/介绍|
|函数名|函数描述/介绍|
|:------|:--------|
| [log.Debug](#debug) |Debugf will print when logger's Level is debug. |
| [log.Error](#error) |Errorf will print only when logger's Level is error, warn, info or debug. |
Expand Down
Loading

0 comments on commit 45c59c2

Please sign in to comment.