nuclei/pkg/js/generated/ts/mssql.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

68 lines
1.9 KiB
TypeScript
Executable File

/**
* Client is a client for MS SQL database.
* Internally client uses denisenkom/go-mssqldb driver.
* @example
* ```javascript
* const mssql = require('nuclei/mssql');
* const client = new mssql.Client();
* ```
*/
export class MSSQLClient {
// Constructor of MSSQLClient
constructor() {}
/**
* Connect connects to MS SQL database using given credentials.
* If connection is successful, it returns true.
* If connection is unsuccessful, it returns false and error.
* The connection is closed after the function returns.
* @example
* ```javascript
* const mssql = require('nuclei/mssql');
* const client = new mssql.Client();
* const connected = client.Connect('acme.com', 1433, 'username', 'password');
* ```
*/
public Connect(host: string, port: number, username: string): boolean | null {
return null;
}
/**
* ConnectWithDB connects to MS SQL database using given credentials and database name.
* If connection is successful, it returns true.
* If connection is unsuccessful, it returns false and error.
* The connection is closed after the function returns.
* @example
* ```javascript
* const mssql = require('nuclei/mssql');
* const client = new mssql.Client();
* const connected = client.ConnectWithDB('acme.com', 1433, 'username', 'password', 'master');
* ```
*/
public ConnectWithDB(host: string, port: number, username: string): boolean | null {
return null;
}
/**
* IsMssql checks if the given host is running MS SQL database.
* If the host is running MS SQL database, it returns true.
* If the host is not running MS SQL database, it returns false.
* @example
* ```javascript
* const mssql = require('nuclei/mssql');
* const isMssql = mssql.IsMssql('acme.com', 1433);
* ```
*/
public IsMssql(host: string, port: number): boolean | null {
return null;
}
}