nuclei/pkg/js/generated/ts/telnet.ts
Tarun Koyalwar 36985345a9
javascript bindings + docs generation enhancements ( generate typescript defination .d.ts files) (#4487)
* introduce typescript files generation using ast + tmpl

* feat valid ts with scraping

* feat remove old logic + tsdocs for all modules

* fix ikev and related bugs

* typescript docs for js modules

* lint,build + ldap realm fix

* go mod tidy

* fix named imports ast parsing

* fix ast code generation errors

* complete support for ts files generation

* support go global/const in ts docs

* updated template

* feat: typescript using go code generation

* nuke jsdoc generator

* update generated ts dir structure

* fix multifile ts gen issue

* fix panic in ts code gen

* fix test

* update docs of js libs

* feat: add doc+example for every js class,function,method

* fix missing quotes in ikev example

---------

Co-authored-by: Sandeep Singh <sandeep@projectdiscovery.io>
2024-02-07 21:45:40 +05:30

51 lines
1014 B
TypeScript
Executable File

/**
* TelnetClient is a minimal Telnet client for nuclei scripts.
* @example
* ```javascript
* const telnet = require('nuclei/telnet');
* const client = new telnet.Client();
* ```
*/
export class TelnetClient {
// Constructor of TelnetClient
constructor() {}
/**
* IsTelnet checks if a host is running a Telnet server.
* @example
* ```javascript
* const telnet = require('nuclei/telnet');
* const isTelnet = telnet.IsTelnet('acme.com', 23);
* log(toJSON(isTelnet));
* ```
*/
public IsTelnet(host: string, port: number): IsTelnetResponse | null {
return null;
}
}
/**
* IsTelnetResponse is the response from the IsTelnet function.
* this is returned by IsTelnet function.
* @example
* ```javascript
* const telnet = require('nuclei/telnet');
* const isTelnet = telnet.IsTelnet('acme.com', 23);
* log(toJSON(isTelnet));
* ```
*/
export interface IsTelnetResponse {
IsTelnet?: boolean,
Banner?: string,
}