API
@the-codegen-project/cli • Docs
API
These are all the exposed types and functions when installing the CLI as a dependency.
Interfaces
| Interface | Description |
|---|---|
| AsyncAPIDocumentInterface | - |
| GenericCodegenContext | - |
| LoadArgument | - |
| ParameterRenderType | - |
| PayloadRenderType | - |
| RunGeneratorContext | - |
| SingleFunctionRenderType | - |
Type Aliases
Variables
Functions
| Function | Description |
|---|---|
| generateTypeScriptChannels | - |
| generateTypescriptParameters | - |
| generateTypescriptPayload | - |
| getDefaultConfiguration | Returns the default generator for the preset of the language |
| loadAndRealizeConfigFile | Load the configuration file and realize it with default options if necessary. |
| loadAsyncapi | - |
| loadConfigFile | Load configuration from file. |
| realizeConfiguration | Ensure that each generator has the default options along side custom properties |
| realizeGeneratorContext | Load configuration and input document to create generator context |
| renderGenerator | - |
| run | - |
| runGenerators | Function that runs the given generator context ensuring the generators are rendered in the correct order. |