Class KotlinGenerator

Abstract generator which must be implemented by each language

Hierarchy

AbstractGenerator<KotlinOptions, KotlinRenderCompleteModelOptions>
- KotlinGenerator
  - KotlinFileGenerator

Index

Constructors

constructor

new KotlinGenerator(options?): KotlinGenerator
Parameters
- Optional options: {
      collectionType?: "List" | "Array";
      constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional collectionType?: "List" | "Array"
  - Optional constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns KotlinGenerator
Overrides AbstractGenerator.constructor
- Defined in src/generators/kotlin/KotlinGenerator.ts:71

Properties

`Readonly` languageName

languageName: string

`Readonly` options

options: KotlinOptions

`Static` defaultOptions

defaultOptions: KotlinOptions = ...

Methods

constrainToMetaModel

constrainToMetaModel(model, options): ConstrainedMetaModel
Parameters
- model: MetaModel
- options: {
      collectionType?: "List" | "Array";
      constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional collectionType?: "List" | "Array"
  - Optional constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns ConstrainedMetaModel
Overrides AbstractGenerator.constrainToMetaModel
- Defined in src/generators/kotlin/KotlinGenerator.ts:113

generate

generate(input): Promise<OutputModel[]>
Generates a scattered model where dependencies and rendered results are separated.
Parameters
- input: any
Returns Promise<OutputModel[]>
Inherited from AbstractGenerator.generate
- Defined in src/generators/AbstractGenerator.ts:228

generateCompleteModels

generateCompleteModels(input, completeOptions): Promise<OutputModel[]>
Generates the full output of a model, instead of a scattered model.

OutputModels result is no longer the model itself, but including package, package dependencies and model dependencies.
Parameters
- input: any
- completeOptions: Partial<KotlinRenderCompleteModelOptions>
Returns Promise<OutputModel[]>
Inherited from AbstractGenerator.generateCompleteModels
- Defined in src/generators/AbstractGenerator.ts:198

getDependencyManager

getDependencyManager(options): KotlinDependencyManager
Wrapper to get an instance of the dependency manager
Parameters
- options: KotlinOptions
Returns KotlinDependencyManager
Overrides AbstractGenerator.getDependencyManager
- Defined in src/generators/kotlin/KotlinGenerator.ts:96

`Protected` getDependencyManagerInstance

getDependencyManagerInstance(options): AbstractDependencyManager
This function returns an instance of the dependency manager which is either a factory or an instance.
Parameters
- options: KotlinOptions
Returns AbstractDependencyManager
Inherited from AbstractGenerator.getDependencyManagerInstance
- Defined in src/generators/AbstractGenerator.ts:106

`Protected` getPresets

getPresets(presetType): [Partial<any>, unknown][]
Get all presets (default and custom ones from options) for a given preset type (class, enum, etc).
Parameters
- presetType: string
Returns [Partial<any>, unknown][]
Inherited from AbstractGenerator.getPresets
- Defined in src/generators/AbstractGenerator.ts:280

process

process(input): Promise<InputMetaModel>
Parameters
- input: Record<string, unknown>
Returns Promise<InputMetaModel>
Inherited from AbstractGenerator.process
- Defined in src/generators/AbstractGenerator.ts:96

`Protected` processInput

processInput(input): Promise<InputMetaModel>
Process any of the input formats to the appropriate InputMetaModel type and split out the meta models based on the requirements of the generators
Parameters
- input: any
Returns Promise<InputMetaModel>
Inherited from AbstractGenerator.processInput
- Defined in src/generators/AbstractGenerator.ts:259

render

render(args): Promise<RenderOutput>
Render a scattered model, where the source code and library and model dependencies are separated.
Parameters
- args: AbstractGeneratorRenderArgs<KotlinOptions, ConstrainedMetaModel>
Returns Promise<RenderOutput>
Overrides AbstractGenerator.render
- Defined in src/generators/kotlin/KotlinGenerator.ts:140

renderClass

renderClass(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedObjectModel
- inputModel: InputMetaModel
- Optional options: {
      collectionType?: "List" | "Array";
      constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional collectionType?: "List" | "Array"
  - Optional constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns Promise<RenderOutput>
- Defined in src/generators/kotlin/KotlinGenerator.ts:220

renderCompleteModel

renderCompleteModel(args): Promise<RenderOutput>
Render a complete model result where the model code, library and model dependencies are all bundled appropriately.

For Kotlin you need to specify which package the model is placed under.
Parameters
- args: AbstractGeneratorRenderCompleteModelArgs<KotlinOptions, KotlinRenderCompleteModelOptions>
Returns Promise<RenderOutput>
Overrides AbstractGenerator.renderCompleteModel
- Defined in src/generators/kotlin/KotlinGenerator.ts:181

renderEnum

renderEnum(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedEnumModel
- inputModel: InputMetaModel
- Optional options: {
      collectionType?: "List" | "Array";
      constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional collectionType?: "List" | "Array"
  - Optional constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns Promise<RenderOutput>
- Defined in src/generators/kotlin/KotlinGenerator.ts:247

`Private` sanitizePackageName

sanitizePackageName(packageName): string
Parameters
- packageName: string
Returns string
- Defined in src/generators/kotlin/KotlinGenerator.ts:209

splitMetaModel

splitMetaModel(model): MetaModel[]
This function makes sure we split up the MetaModels accordingly to what we want to render as models.
Parameters
- model: MetaModel
Returns MetaModel[]
Overrides AbstractGenerator.splitMetaModel
- Defined in src/generators/kotlin/KotlinGenerator.ts:105

`Static` getKotlinOptions

getKotlinOptions(options?): KotlinOptions
Returns the Kotlin options by merging custom options with default ones.
Parameters
- Optional options: {
      collectionType?: "List" | "Array";
      constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; };
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional collectionType?: "List" | "Array"
  - Optional constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; } | undefined; options?: any; }))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns KotlinOptions
- Defined in src/generators/kotlin/KotlinGenerator.ts:79

Class KotlinGenerator

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional collectionType?: "List" | "Array"

Optional constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

Returns KotlinGenerator

Properties

Readonly languageName

Readonly options

Static defaultOptions

Methods

constrainToMetaModel

Parameters

model: MetaModel

Optional collectionType?: "List" | "Array"

Optional constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

Returns ConstrainedMetaModel

generate

Parameters

input: any

Returns Promise<OutputModel[]>

generateCompleteModels

Parameters

input: any

completeOptions: Partial<KotlinRenderCompleteModelOptions>

Returns Promise<OutputModel[]>

getDependencyManager

Parameters

options: KotlinOptions

Returns KotlinDependencyManager

Protected getDependencyManagerInstance

Parameters

options: KotlinOptions

Returns AbstractDependencyManager

Protected getPresets

Parameters

presetType: string

Returns [Partial<any>, unknown][]

process

Parameters

input: Record<string, unknown>

Returns Promise<InputMetaModel>

Protected processInput

Parameters

input: any

Returns Promise<InputMetaModel>

render

Parameters

args: AbstractGeneratorRenderArgs<KotlinOptions, ConstrainedMetaModel>

Returns Promise<RenderOutput>

renderClass

Parameters

model: ConstrainedObjectModel

inputModel: InputMetaModel

Optional collectionType?: "List" | "Array"

Optional constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

Optional defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

Returns Promise<RenderOutput>

renderCompleteModel

Parameters

args: AbstractGeneratorRenderCompleteModelArgs<KotlinOptions, KotlinRenderCompleteModelOptions>

Returns Promise<RenderOutput>

renderEnum

`Optional` collectionType?: "List" | "Array"

`Optional` constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

`Optional` dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Readonly` languageName

`Readonly` options

`Static` defaultOptions

`Optional` collectionType?: "List" | "Array"

`Optional` constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

`Optional` dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Protected` getDependencyManagerInstance

`Protected` getPresets

`Protected` processInput

`Optional` collectionType?: "List" | "Array"

`Optional` constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

`Optional` dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Optional` collectionType?: "List" | "Array"

`Optional` constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

`Optional` dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Private` sanitizePackageName

`Static` getKotlinOptions

`Optional` collectionType?: "List" | "Array"

`Optional` constraints?: { enumKey?: EnumKeyConstraint<KotlinOptions> | undefined; enumValue?: EnumValueConstraint<KotlinOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` defaultPreset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; enum?: { ...; } | undefined; }

`Optional` dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, KotlinOptions, KotlinDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }