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

50 lines
1.3 KiB
TypeScript
Executable File

/**
* StructsPack returns a byte slice containing the values of msg slice packed according to the given format.
* The items of msg slice must match the values required by the format exactly.
* Ex: structs.pack("H", 0)
* @example
* ```javascript
* const structs = require('nuclei/structs');
* const packed = structs.Pack('H', [0]);
* ```
*/
export function Pack(formatStr: string, msg: any): Uint8Array | null {
return null;
}
/**
* StructsCalcSize returns the number of bytes needed to pack the values according to the given format.
* Ex: structs.CalcSize("H")
* @example
* ```javascript
* const structs = require('nuclei/structs');
* const size = structs.CalcSize('H');
* ```
*/
export function StructsCalcSize(format: string): number | null {
return null;
}
/**
* StructsUnpack the byte slice (presumably packed by Pack(format, msg)) according to the given format.
* The result is a []interface{} slice even if it contains exactly one item.
* The byte slice must contain not less the amount of data required by the format
* (len(msg) must more or equal CalcSize(format)).
* Ex: structs.Unpack(">I", buff[:nb])
* @example
* ```javascript
* const structs = require('nuclei/structs');
* const result = structs.Unpack('H', [0]);
* ```
*/
export function Unpack(format: string, msg: Uint8Array): any | null {
return null;
}