RunGeneratorContext
@the-codegen-project/cli • Docs
Home / RunGeneratorContext
Interface: RunGeneratorContext
Properties
| Property | Type | Defined in |
|---|---|---|
asyncapiDocument? | AsyncAPIDocumentInterface | src/codegen/types.ts:239 |
configFilePath | string | src/codegen/types.ts:237 |
configuration | { $schema: string; generators: ( | { dependencies: string[]; id: string; language: "typescript"; outputPath: string; preset: "parameters"; serializationType: "json"; } | { channelsGeneratorId: string; dependencies: string[]; id: string; language: "typescript"; outputPath: string; preset: "client"; protocols: "nats"[]; } | { dependencies: string[]; enum: "enum" | "union"; id: string; includeValidation: boolean; language: "typescript"; map: "map" | "indexedObject" | "record"; outputPath: string; preset: "payloads"; rawPropertyNames: boolean; serializationType: "json"; useForJavaScript: boolean; } | { asyncapiGenerateForOperations: boolean; asyncapiReverseOperations: boolean; dependencies: string[]; eventSourceDependency: string; functionTypeMapping: Record<string, undefined | ChannelFunctionTypes[]>; headerGeneratorId: string; id: string; kafkaTopicSeparator: string; language: "typescript"; outputPath: string; parameterGeneratorId: string; payloadGeneratorId: string; preset: "channels"; protocols: ( | "nats" | "kafka" | "mqtt" | "amqp" | "event_source" | "http_client" | "websocket")[]; } | { dependencies: string[]; id: string; includeValidation: boolean; language: "typescript"; outputPath: string; preset: "headers"; serializationType: "json"; } | { dependencies: string[]; id: string; language: "typescript"; outputPath: string; preset: "types"; } | { dependencies: string[]; id: string; language: "typescript"; options: { constraints: any; defaultPreset: any; dependencyManager: { dependencies: ...[]; }; enumType: "enum" | "union"; indentation: { size: number; type: "spaces" | "tabs"; }; mapType: "map" | "indexedObject" | "record"; modelType: "class" | "interface"; moduleSystem: "ESM" | "CJS"; presets: any; processorOptions: any; rawPropertyNames: boolean; renderTypes: boolean; typeMapping: any; useJavascriptReservedKeywords: boolean; }; outputPath: string; preset: "models"; renderers: zodTypeScriptPresets; } | { dependencies: string[]; id: string; language: "typescript"; options: any; outputPath: string; preset: "custom"; renderFunction: (...args) => any; })[]; inputPath: string; inputType: "asyncapi"; language: "typescript"; } | { $schema: string; generators: ( | { dependencies: string[]; id: string; language: "typescript"; outputPath: string; preset: "parameters"; serializationType: "json"; } | { dependencies: string[]; enum: "enum" | "union"; id: string; includeValidation: boolean; language: "typescript"; map: "map" | "indexedObject" | "record"; outputPath: string; preset: "payloads"; rawPropertyNames: boolean; serializationType: "json"; useForJavaScript: boolean; } | { asyncapiGenerateForOperations: boolean; asyncapiReverseOperations: boolean; dependencies: string[]; eventSourceDependency: string; functionTypeMapping: Record<string, undefined | ChannelFunctionTypes[]>; headerGeneratorId: string; id: string; kafkaTopicSeparator: string; language: "typescript"; outputPath: string; parameterGeneratorId: string; payloadGeneratorId: string; preset: "channels"; protocols: ( | "nats" | "kafka" | "mqtt" | "amqp" | "event_source" | "http_client" | "websocket")[]; } | { dependencies: string[]; id: string; includeValidation: boolean; language: "typescript"; outputPath: string; preset: "headers"; serializationType: "json"; } | { dependencies: string[]; id: string; language: "typescript"; outputPath: string; preset: "types"; } | { dependencies: string[]; id: string; language: "typescript"; options: { constraints: any; defaultPreset: any; dependencyManager: { dependencies: ...[]; }; enumType: "enum" | "union"; indentation: { size: number; type: "spaces" | "tabs"; }; mapType: "map" | "indexedObject" | "record"; modelType: "class" | "interface"; moduleSystem: "ESM" | "CJS"; presets: any; processorOptions: any; rawPropertyNames: boolean; renderTypes: boolean; typeMapping: any; useJavascriptReservedKeywords: boolean; }; outputPath: string; preset: "models"; renderers: zodTypeScriptPresets; } | { dependencies: string[]; id: string; language: "typescript"; options: any; outputPath: string; preset: "custom"; renderFunction: (...args) => any; })[]; inputPath: string; inputType: "openapi"; language: "typescript"; } | { $schema: string; generators: ({ dependencies: string[]; id: string; language: "typescript"; options: { constraints: any; defaultPreset: any; dependencyManager: { dependencies: ...[]; }; enumType: "enum" | "union"; indentation: { size: number; type: "spaces" | "tabs"; }; mapType: "map" | "indexedObject" | "record"; modelType: "class" | "interface"; moduleSystem: "ESM" | "CJS"; presets: any; processorOptions: any; rawPropertyNames: boolean; renderTypes: boolean; typeMapping: any; useJavascriptReservedKeywords: boolean; }; outputPath: string; preset: "models"; renderers: zodTypeScriptPresets; } | { dependencies: string[]; id: string; language: "typescript"; options: any; outputPath: string; preset: "custom"; renderFunction: (...args) => any; })[]; inputPath: string; inputType: "jsonschema"; language: "typescript"; } | src/codegen/types.ts:236 |
documentPath | string | src/codegen/types.ts:238 |
jsonSchemaDocument? | JsonSchemaDocument | src/codegen/types.ts:244 |
openapiDocument? | Document<{}> | Document<{}> | Document<{}> | src/codegen/types.ts:240 |