mirror of
https://github.com/projectdiscovery/nuclei.git
synced 2025-12-29 18:03:07 +00:00
4f93520e47
* rebase js-layer PR from @ice3man543 * package restructuring * working * fix duplicated event & matcher status * fix lint error * fix response field * add new functions * multiple minor improvements * fix incorrect stats in js protocol * sort output metadata in cli * remove temp files * remove dead code * add unit and integration test * fix lint error * add jsdoclint using llm * fix error in test * add js lint using llm * generate docs of libs * llm lint * remove duplicated docs * update generated docs * update prompt in doclint * update docs * temp disable version check test * fix unit test and add retry * fix panic in it * update and move jsdocs * updated jsdocs * update docs * update container platform in test * dir restructure and adding docs * add api_reference and remove markdown docs * fix imports * add javascript design and contribution docs * add js protocol documentation * update integration test and docs * update doc ext mdx->md * minor update to docs * new integration test and more * move go libs and add docs * gen new net docs and more * final docs update * add new devtool * use fastdialer * fix build fail * use fastdialer + network sandbox support * add reserved keyword 'Port' * update Port to new syntax * misc update * always enable templatectx in js protocol * move docs to 'js-proto-docs' repo * remove scrapefuncs binary --------- Co-authored-by: sandeep <8293321+ehsandeep@users.noreply.github.com>
72 lines
1.8 KiB
Cheetah
72 lines
1.8 KiB
Cheetah
{{$packageName:=(printf "%s" .PackageName) -}}
|
|
## {{$packageName}}
|
|
---
|
|
|
|
|
|
`{{$packageName}}` implements bindings for `{{.PackageName}}` protocol in javascript
|
|
to be used from nuclei scanner.
|
|
|
|
|
|
{{ if .PackageFuncsExtra }}
|
|
## Types
|
|
|
|
{{- range $typeName, $methods := .PackageFuncsExtra }}
|
|
|
|
### {{$typeName}}
|
|
|
|
{{ uncomment $methods.Doc }}
|
|
|
|
| Method | Description | Arguments | Returns |
|
|
|--------|-------------|-----------|---------|
|
|
{{- range $methodName, $method := $methods.Items }}
|
|
| `{{$methodName}}` | {{uncomment $method.Doc}} | {{range $index, $arg := $method.Args}}{{if $index}}, {{end}}`{{ $arg }}`{{end}} | {{range $idx, $arg := $method.Returns}}{{if $idx}}, {{end}}`{{ $arg }}`{{end}} |
|
|
{{- end }}
|
|
|
|
{{- end }}
|
|
{{- end }}
|
|
|
|
{{ if .PackageFuncsExtraNoType }}
|
|
## Exported Functions
|
|
|
|
| Name | Description | Arguments | Returns |
|
|
|--------|-------------|-----------|---------|
|
|
{{- range $objName, $method := .PackageFuncsExtraNoType}}
|
|
{{$objName}} | {{uncomment $method.Doc}} | {{range $index, $arg := $method.Args}}{{if $index}}, {{end}}`{{ $arg }}`{{end}} | {{range $idx, $arg := $method.Returns}}{{if $idx}}, {{end}}`{{ $arg }}`{{end}} |
|
|
{{- end}}
|
|
{{- end}}
|
|
|
|
{{ if .PackageTypesExtra }}
|
|
## Exported Types Fields
|
|
|
|
{{- range $typeName, $methods := .PackageTypesExtra }}
|
|
### {{$typeName}}
|
|
|
|
| Name | Type |
|
|
|--------|-------------|
|
|
{{- range $fieldName, $field := $methods.Fields }}
|
|
| {{$fieldName}} | `{{ $field }}` |
|
|
{{- end }}
|
|
{{- end }}
|
|
{{- end }}
|
|
|
|
{{ if .PackageVarsValues }}
|
|
|
|
## Exported Variables Values
|
|
|
|
| Name | Value |
|
|
|--------|-------------|
|
|
{{- range $varName, $var := .PackageVarsValues }}
|
|
| {{$varName}} | `{{ $var }}` |
|
|
{{- end }}
|
|
{{- end}}
|
|
|
|
{{ if .PackageInterfaces }}
|
|
## Exported Interfaces
|
|
|
|
{{- range $typeName, $doc := .PackageInterfaces }}
|
|
### {{$typeName}}
|
|
|
|
{{ uncomment $doc }}
|
|
{{- end }}
|
|
{{- end }}
|