RunGeneratorContext

@the-codegen-project/cli • Docs

---

Home / RunGeneratorContext

Interface: RunGeneratorContext

Properties

Property	Type	Defined in
asyncapiDocument?	AsyncAPIDocumentInterface	src/codegen/types.ts:209
configFilePath	string	src/codegen/types.ts:207
configuration	{ $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[]>; id: string; kafkaTopicSeparator: string; language: "typescript"; outputPath: string; parameterGeneratorId: string; payloadGeneratorId: string; preset: "channels"; protocols: ( | "http_client" | "nats" | "kafka" | "mqtt" | "amqp" | "event_source")[]; } | { channelsGeneratorId: string; dependencies: string[]; id: string; language: "typescript"; outputPath: string; preset: "client"; protocols: "nats"[]; } | { 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: any; outputPath: string; preset: "custom"; renderFunction: (...args) => any; })[]; inputPath: string; inputType: "asyncapi"; language: "typescript"; } | { $schema: string; generators: ({ 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; } | { dependencies: string[]; id: string; includeValidation: boolean; language: "typescript"; outputPath: string; preset: "headers"; serializationType: "json"; } | { dependencies: string[]; id: string; language: "typescript"; options: any; outputPath: string; preset: "custom"; renderFunction: (...args) => any; })[]; inputPath: string; inputType: "openapi"; language: "typescript"; }	src/codegen/types.ts:206
documentPath	string	src/codegen/types.ts:208
openapiDocument?	Document<{}> | Document<{}> | Document<{}>	src/codegen/types.ts:210