Skip to content

@yantrix/codegen v0.5.2 • Docs


Yantrix API / @yantrix/codegen / ICodegen

Interface: ICodegen<T> ​

Interface that is implemented by all code generators.

Type Parameters ​

• T extends TOutLang

The output language.

Properties ​

getCode() ​

ts
getCode: (options) => string;

The function that returns the generated code, following all the conventions established by the output language T.

Parameters ​

• options: TGetCodeOptionsMap[T]

Returns ​

string


getFiles()? ​

ts
optional getFiles: (options) => TCodegenFiles;

Optional multi-file output. When present, returns a map of relative filenames to content.

Parameters ​

• options: TGetCodeOptionsMap[T]

Returns ​

TCodegenFiles