Skip to main content

RunGeneratorContext

@the-codegen-project/cli • Docs

Home / RunGeneratorContext

Interface: RunGeneratorContext

Properties

Property	Type	Defined in
`asyncapiDocument?`	`AsyncAPIDocumentInterface`	src/codegen/types.ts:153
`configFilePath`	`string`	src/codegen/types.ts:151
`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`: ( \| `"nats"` \| `"kafka"` \| `"mqtt"` \| `"amqp"` \| `"event_source"`)[]; } \| { `channelsGeneratorId`: `string`; `dependencies`: `string`[]; `id`: `string`; `language`: `"typescript"`; `outputPath`: `string`; `preset`: `"client"`; `protocols`: `"nats"`[]; } \| { `dependencies`: `string`[]; `id`: `string`; `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`: `"asyncapi"`; `language`: `"typescript"`; }	src/codegen/types.ts:150
`configuration.$schema?`	`string`	src/codegen/types.ts:120
`configuration.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`: ( \| `"nats"` \| `"kafka"` \| `"mqtt"` \| `"amqp"` \| `"event_source"`)[]; } \| { `channelsGeneratorId`: `string`; `dependencies`: `string`[]; `id`: `string`; `language`: `"typescript"`; `outputPath`: `string`; `preset`: `"client"`; `protocols`: `"nats"`[]; } \| { `dependencies`: `string`[]; `id`: `string`; `language`: `"typescript"`; `outputPath`: `string`; `preset`: `"headers"`; `serializationType`: `"json"`; } \| { `dependencies`: `string`[]; `id`: `string`; `language`: `"typescript"`; `options`: `any`; `outputPath`: `string`; `preset`: `"custom"`; `renderFunction`: (...`args`) => `any`; })[]	src/codegen/types.ts:134
`configuration.inputPath`	`string`	src/codegen/types.ts:127
`configuration.inputType`	`"asyncapi"`	src/codegen/types.ts:126
`configuration.language?`	`"typescript"`	src/codegen/types.ts:128
`documentPath`	`string`	src/codegen/types.ts:152

Properties