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

79 lines
1.9 KiB
TypeScript
Executable File

/**
* ListDir lists itemType values within a directory
* depending on the itemType provided
* itemType can be any one of ['file','dir',”]
* @example
* ```javascript
* const fs = require('nuclei/fs');
* // this will only return files in /tmp directory
* const files = fs.ListDir('/tmp', 'file');
* ```
* @example
* ```javascript
* const fs = require('nuclei/fs');
* // this will only return directories in /tmp directory
* const dirs = fs.ListDir('/tmp', 'dir');
* ```
* @example
* ```javascript
* const fs = require('nuclei/fs');
* // when no itemType is provided, it will return both files and directories
* const items = fs.ListDir('/tmp');
* ```
*/
export function ListDir(path: string, itemType: string): string[] | null {
return null;
}
/**
* ReadFile reads file contents within permitted paths
* and returns content as byte array
* @example
* ```javascript
* const fs = require('nuclei/fs');
* // here permitted directories are $HOME/nuclei-templates/*
* const content = fs.ReadFile('helpers/usernames.txt');
* ```
*/
export function ReadFile(path: string): Uint8Array | null {
return null;
}
/**
* ReadFileAsString reads file contents within permitted paths
* and returns content as string
* @example
* ```javascript
* const fs = require('nuclei/fs');
* // here permitted directories are $HOME/nuclei-templates/*
* const content = fs.ReadFileAsString('helpers/usernames.txt');
* ```
*/
export function ReadFileAsString(path: string): string | null {
return null;
}
/**
* ReadFilesFromDir reads all files from a directory
* and returns a string array with file contents of all files
* @example
* ```javascript
* const fs = require('nuclei/fs');
* // here permitted directories are $HOME/nuclei-templates/*
* const contents = fs.ReadFilesFromDir('helpers/ssh-keys');
* log(contents);
* ```
*/
export function ReadFilesFromDir(dir: string): string[] | null {
return null;
}