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
960 B
TypeScript
Executable File

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