Class TypeScriptGenerator

Generator for TypeScript

Hierarchy

AbstractGenerator<TypeScriptOptions, TypeScriptRenderCompleteModelOptions>
- TypeScriptGenerator
  - TypeScriptFileGenerator

Constructors

constructor

new TypeScriptGenerator(options?): TypeScriptGenerator
Parameters
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<TypeScriptOptions> | undefined; enumValue?: EnumValueConstraint<TypeScriptOptions> | 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; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...;
      dependencyManager?: (() => TypeScriptDependencyManager) | ({ options?: { renderTypes?: boolean | undefined; modelType?: "class" | "interface" | undefined; enumType?: "enum" | "union" | undefined; mapType?: "map" | "record" | "indexedObject" | undefined; ... 9 more ...; dependencyManager?: (() => TypeScriptDependencyManager) | ... 1 more ... | undefined; } | undefined; ... 5...);
      enumType?: "enum" | "union";
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      mapType?: "map" | "record" | "indexedObject";
      modelType?: "class" | "interface";
      moduleSystem?: TypeScriptModuleSystemType;
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; typ...))[];
      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...;
      rawPropertyNames?: boolean;
      renderTypes?: boolean;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, TypeScriptOptions, TypeScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
      useJavascriptReservedKeywords?: boolean;
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<TypeScriptOptions> | undefined; enumValue?: EnumValueConstraint<TypeScriptOptions> | 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; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...
  - Optional dependencyManager?: (() => TypeScriptDependencyManager) | ({ options?: { renderTypes?: boolean | undefined; modelType?: "class" | "interface" | undefined; enumType?: "enum" | "union" | undefined; mapType?: "map" | "record" | "indexedObject" | undefined; ... 9 more ...; dependencyManager?: (() => TypeScriptDependencyManager) | ... 1 more ... | undefined; } | undefined; ... 5...)
    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 enumType?: "enum" | "union"
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional mapType?: "map" | "record" | "indexedObject"
  - Optional modelType?: "class" | "interface"
  - Optional moduleSystem?: TypeScriptModuleSystemType
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; typ...))[]
  - 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 rawPropertyNames?: boolean
    
    Use raw property names instead of constrained ones, where you most likely need to access them with obj["propertyName"] instead of obj.propertyName
  - Optional renderTypes?: boolean
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, TypeScriptOptions, TypeScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
  - Optional useJavascriptReservedKeywords?: boolean
    
    Use JS reserved keywords so the TS output models can easily be transpiled to JS
Returns TypeScriptGenerator
Overrides AbstractGenerator.constructor
- Defined in src/generators/typescript/TypeScriptGenerator.ts:110

Properties

`Readonly` languageName

languageName: string

`Readonly` options

options: TypeScriptOptions

`Static` defaultCompleteModelOptions

defaultCompleteModelOptions: TypeScriptRenderCompleteModelOptions = ...

`Static` defaultOptions

defaultOptions: TypeScriptOptions = ...

Methods

constrainToMetaModel

constrainToMetaModel(model, options): ConstrainedMetaModel
Parameters
- model: MetaModel
- options: {
      constraints?: { enumKey?: EnumKeyConstraint<TypeScriptOptions> | undefined; enumValue?: EnumValueConstraint<TypeScriptOptions> | 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; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...;
      dependencyManager?: (() => TypeScriptDependencyManager) | ({ options?: { renderTypes?: boolean | undefined; modelType?: "class" | "interface" | undefined; enumType?: "enum" | "union" | undefined; mapType?: "map" | "record" | "indexedObject" | undefined; ... 9 more ...; dependencyManager?: (() => TypeScriptDependencyManager) | ... 1 more ... | undefined; } | undefined; ... 5...);
      enumType?: "enum" | "union";
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      mapType?: "map" | "record" | "indexedObject";
      modelType?: "class" | "interface";
      moduleSystem?: TypeScriptModuleSystemType;
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; typ...))[];
      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...;
      rawPropertyNames?: boolean;
      renderTypes?: boolean;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, TypeScriptOptions, TypeScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
      useJavascriptReservedKeywords?: boolean;
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<TypeScriptOptions> | undefined; enumValue?: EnumValueConstraint<TypeScriptOptions> | 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; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...
  - Optional dependencyManager?: (() => TypeScriptDependencyManager) | ({ options?: { renderTypes?: boolean | undefined; modelType?: "class" | "interface" | undefined; enumType?: "enum" | "union" | undefined; mapType?: "map" | "record" | "indexedObject" | undefined; ... 9 more ...; dependencyManager?: (() => TypeScriptDependencyManager) | ... 1 more ... | undefined; } | undefined; ... 5...)
    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 enumType?: "enum" | "union"
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional mapType?: "map" | "record" | "indexedObject"
  - Optional modelType?: "class" | "interface"
  - Optional moduleSystem?: TypeScriptModuleSystemType
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; typ...))[]
  - 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 rawPropertyNames?: boolean
    
    Use raw property names instead of constrained ones, where you most likely need to access them with obj["propertyName"] instead of obj.propertyName
  - Optional renderTypes?: boolean
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, TypeScriptOptions, TypeScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
  - Optional useJavascriptReservedKeywords?: boolean
    
    Use JS reserved keywords so the TS output models can easily be transpiled to JS
Returns ConstrainedMetaModel
Overrides AbstractGenerator.constrainToMetaModel
- Defined in src/generators/typescript/TypeScriptGenerator.ts:157

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<TypeScriptRenderCompleteModelOptions>
Returns Promise<OutputModel[]>
Inherited from AbstractGenerator.generateCompleteModels
- Defined in src/generators/AbstractGenerator.ts:198

getDependencyManager

getDependencyManager(options): TypeScriptDependencyManager
Wrapper to get an instance of the dependency manager
Parameters
- options: TypeScriptOptions
Returns TypeScriptDependencyManager
Overrides AbstractGenerator.getDependencyManager
- Defined in src/generators/typescript/TypeScriptGenerator.ts:140

`Protected` getDependencyManagerInstance

getDependencyManagerInstance(options): AbstractDependencyManager
This function returns an instance of the dependency manager which is either a factory or an instance.
Parameters
- options: TypeScriptOptions
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 any ConstrainedMetaModel to code based on the type
Parameters
- args: AbstractGeneratorRenderArgs<TypeScriptOptions, ConstrainedMetaModel>
Returns Promise<RenderOutput>
Overrides AbstractGenerator.render
- Defined in src/generators/typescript/TypeScriptGenerator.ts:239

renderClass

renderClass(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedObjectModel
- inputModel: InputMetaModel
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<TypeScriptOptions> | undefined; enumValue?: EnumValueConstraint<TypeScriptOptions> | 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; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...;
      dependencyManager?: (() => TypeScriptDependencyManager) | ({ options?: { renderTypes?: boolean | undefined; modelType?: "class" | "interface" | undefined; enumType?: "enum" | "union" | undefined; mapType?: "map" | "record" | "indexedObject" | undefined; ... 9 more ...; dependencyManager?: (() => TypeScriptDependencyManager) | ... 1 more ... | undefined; } | undefined; ... 5...);
      enumType?: "enum" | "union";
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      mapType?: "map" | "record" | "indexedObject";
      modelType?: "class" | "interface";
      moduleSystem?: TypeScriptModuleSystemType;
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; typ...))[];
      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...;
      rawPropertyNames?: boolean;
      renderTypes?: boolean;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, TypeScriptOptions, TypeScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
      useJavascriptReservedKeywords?: boolean;
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<TypeScriptOptions> | undefined; enumValue?: EnumValueConstraint<TypeScriptOptions> | 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; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...
  - Optional dependencyManager?: (() => TypeScriptDependencyManager) | ({ options?: { renderTypes?: boolean | undefined; modelType?: "class" | "interface" | undefined; enumType?: "enum" | "union" | undefined; mapType?: "map" | "record" | "indexedObject" | undefined; ... 9 more ...; dependencyManager?: (() => TypeScriptDependencyManager) | ... 1 more ... | undefined; } | undefined; ... 5...)
    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 enumType?: "enum" | "union"
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional mapType?: "map" | "record" | "indexedObject"
  - Optional modelType?: "class" | "interface"
  - Optional moduleSystem?: TypeScriptModuleSystemType
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; typ...))[]
  - 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 rawPropertyNames?: boolean
    
    Use raw property names instead of constrained ones, where you most likely need to access them with obj["propertyName"] instead of obj.propertyName
  - Optional renderTypes?: boolean
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, TypeScriptOptions, TypeScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
  - Optional useJavascriptReservedKeywords?: boolean
    
    Use JS reserved keywords so the TS output models can easily be transpiled to JS
Returns Promise<RenderOutput>
- Defined in src/generators/typescript/TypeScriptGenerator.ts:273

renderCompleteModel

renderCompleteModel(args): Promise<RenderOutput>
Render a complete model result where the model code, library and model dependencies are all bundled appropriately.
Parameters
- args: AbstractGeneratorRenderCompleteModelArgs<TypeScriptOptions, TypeScriptRenderCompleteModelOptions>
Returns Promise<RenderOutput>
Overrides AbstractGenerator.renderCompleteModel
- Defined in src/generators/typescript/TypeScriptGenerator.ts:185

renderEnum

renderEnum(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedEnumModel
- inputModel: InputMetaModel
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<TypeScriptOptions> | undefined; enumValue?: EnumValueConstraint<TypeScriptOptions> | 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; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...;
      dependencyManager?: (() => TypeScriptDependencyManager) | ({ options?: { renderTypes?: boolean | undefined; modelType?: "class" | "interface" | undefined; enumType?: "enum" | "union" | undefined; mapType?: "map" | "record" | "indexedObject" | undefined; ... 9 more ...; dependencyManager?: (() => TypeScriptDependencyManager) | ... 1 more ... | undefined; } | undefined; ... 5...);
      enumType?: "enum" | "union";
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      mapType?: "map" | "record" | "indexedObject";
      modelType?: "class" | "interface";
      moduleSystem?: TypeScriptModuleSystemType;
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; typ...))[];
      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...;
      rawPropertyNames?: boolean;
      renderTypes?: boolean;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, TypeScriptOptions, TypeScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
      useJavascriptReservedKeywords?: boolean;
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<TypeScriptOptions> | undefined; enumValue?: EnumValueConstraint<TypeScriptOptions> | 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; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...
  - Optional dependencyManager?: (() => TypeScriptDependencyManager) | ({ options?: { renderTypes?: boolean | undefined; modelType?: "class" | "interface" | undefined; enumType?: "enum" | "union" | undefined; mapType?: "map" | "record" | "indexedObject" | undefined; ... 9 more ...; dependencyManager?: (() => TypeScriptDependencyManager) | ... 1 more ... | undefined; } | undefined; ... 5...)
    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 enumType?: "enum" | "union"
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional mapType?: "map" | "record" | "indexedObject"
  - Optional modelType?: "class" | "interface"
  - Optional moduleSystem?: TypeScriptModuleSystemType
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; typ...))[]
  - 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 rawPropertyNames?: boolean
    
    Use raw property names instead of constrained ones, where you most likely need to access them with obj["propertyName"] instead of obj.propertyName
  - Optional renderTypes?: boolean
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, TypeScriptOptions, TypeScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
  - Optional useJavascriptReservedKeywords?: boolean
    
    Use JS reserved keywords so the TS output models can easily be transpiled to JS
Returns Promise<RenderOutput>
- Defined in src/generators/typescript/TypeScriptGenerator.ts:327

renderInterface

renderInterface(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedObjectModel
- inputModel: InputMetaModel
- Optional options: Partial<TypeScriptOptions>
Returns Promise<RenderOutput>
- Defined in src/generators/typescript/TypeScriptGenerator.ts:300

renderType

renderType(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedMetaModel
- inputModel: InputMetaModel
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<TypeScriptOptions> | undefined; enumValue?: EnumValueConstraint<TypeScriptOptions> | 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; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...;
      dependencyManager?: (() => TypeScriptDependencyManager) | ({ options?: { renderTypes?: boolean | undefined; modelType?: "class" | "interface" | undefined; enumType?: "enum" | "union" | undefined; mapType?: "map" | "record" | "indexedObject" | undefined; ... 9 more ...; dependencyManager?: (() => TypeScriptDependencyManager) | ... 1 more ... | undefined; } | undefined; ... 5...);
      enumType?: "enum" | "union";
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      mapType?: "map" | "record" | "indexedObject";
      modelType?: "class" | "interface";
      moduleSystem?: TypeScriptModuleSystemType;
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; typ...))[];
      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...;
      rawPropertyNames?: boolean;
      renderTypes?: boolean;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, TypeScriptOptions, TypeScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
      useJavascriptReservedKeywords?: boolean;
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<TypeScriptOptions> | undefined; enumValue?: EnumValueConstraint<TypeScriptOptions> | 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; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...
  - Optional dependencyManager?: (() => TypeScriptDependencyManager) | ({ options?: { renderTypes?: boolean | undefined; modelType?: "class" | "interface" | undefined; enumType?: "enum" | "union" | undefined; mapType?: "map" | "record" | "indexedObject" | undefined; ... 9 more ...; dependencyManager?: (() => TypeScriptDependencyManager) | ... 1 more ... | undefined; } | undefined; ... 5...)
    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 enumType?: "enum" | "union"
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional mapType?: "map" | "record" | "indexedObject"
  - Optional modelType?: "class" | "interface"
  - Optional moduleSystem?: TypeScriptModuleSystemType
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; typ...))[]
  - 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 rawPropertyNames?: boolean
    
    Use raw property names instead of constrained ones, where you most likely need to access them with obj["propertyName"] instead of obj.propertyName
  - Optional renderTypes?: boolean
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, TypeScriptOptions, TypeScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
  - Optional useJavascriptReservedKeywords?: boolean
    
    Use JS reserved keywords so the TS output models can easily be transpiled to JS
Returns Promise<RenderOutput>
- Defined in src/generators/typescript/TypeScriptGenerator.ts:354

splitMetaModel

splitMetaModel(model): MetaModel[]
Parameters
- model: MetaModel
Returns MetaModel[]
Overrides AbstractGenerator.splitMetaModel
- Defined in src/generators/typescript/TypeScriptGenerator.ts:148

`Static` getOptions

getOptions(options?): TypeScriptOptions
Returns the TypeScript options by merging custom options with default ones.
Parameters
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<TypeScriptOptions> | undefined; enumValue?: EnumValueConstraint<TypeScriptOptions> | 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; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...;
      dependencyManager?: (() => TypeScriptDependencyManager) | ({ options?: { renderTypes?: boolean | undefined; modelType?: "class" | "interface" | undefined; enumType?: "enum" | "union" | undefined; mapType?: "map" | "record" | "indexedObject" | undefined; ... 9 more ...; dependencyManager?: (() => TypeScriptDependencyManager) | ... 1 more ... | undefined; } | undefined; ... 5...);
      enumType?: "enum" | "union";
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      mapType?: "map" | "record" | "indexedObject";
      modelType?: "class" | "interface";
      moduleSystem?: TypeScriptModuleSystemType;
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; typ...))[];
      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...;
      rawPropertyNames?: boolean;
      renderTypes?: boolean;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, TypeScriptOptions, TypeScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
      useJavascriptReservedKeywords?: boolean;
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<TypeScriptOptions> | undefined; enumValue?: EnumValueConstraint<TypeScriptOptions> | 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; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...
  - Optional dependencyManager?: (() => TypeScriptDependencyManager) | ({ options?: { renderTypes?: boolean | undefined; modelType?: "class" | "interface" | undefined; enumType?: "enum" | "union" | undefined; mapType?: "map" | "record" | "indexedObject" | undefined; ... 9 more ...; dependencyManager?: (() => TypeScriptDependencyManager) | ... 1 more ... | undefined; } | undefined; ... 5...)
    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 enumType?: "enum" | "union"
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional mapType?: "map" | "record" | "indexedObject"
  - Optional modelType?: "class" | "interface"
  - Optional moduleSystem?: TypeScriptModuleSystemType
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; type?: { ...; ...) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; interface?: { ...; } | undefined; enum?: { ...; } | undefined; typ...))[]
  - 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 rawPropertyNames?: boolean
    
    Use raw property names instead of constrained ones, where you most likely need to access them with obj["propertyName"] instead of obj.propertyName
  - Optional renderTypes?: boolean
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, TypeScriptOptions, TypeScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
  - Optional useJavascriptReservedKeywords?: boolean
    
    Use JS reserved keywords so the TS output models can easily be transpiled to JS
Returns TypeScriptOptions
- Defined in src/generators/typescript/TypeScriptGenerator.ts:118

Class TypeScriptGenerator

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional enumType?: "enum" | "union"

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

Optional mapType?: "map" | "record" | "indexedObject"

Optional modelType?: "class" | "interface"

Optional moduleSystem?: TypeScriptModuleSystemType

Optional rawPropertyNames?: boolean

Optional renderTypes?: boolean

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

Optional useJavascriptReservedKeywords?: boolean

Returns TypeScriptGenerator

Properties

Readonly languageName

Readonly options

Static defaultCompleteModelOptions

Static defaultOptions

Methods

constrainToMetaModel

Parameters

model: MetaModel

Optional enumType?: "enum" | "union"

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

Optional mapType?: "map" | "record" | "indexedObject"

Optional modelType?: "class" | "interface"

Optional moduleSystem?: TypeScriptModuleSystemType

Optional rawPropertyNames?: boolean

Optional renderTypes?: boolean

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

Optional useJavascriptReservedKeywords?: boolean

Returns ConstrainedMetaModel

generate

Parameters

input: any

Returns Promise<OutputModel[]>

generateCompleteModels

Parameters

input: any

completeOptions: Partial<TypeScriptRenderCompleteModelOptions>

Returns Promise<OutputModel[]>

getDependencyManager

Parameters

options: TypeScriptOptions

Returns TypeScriptDependencyManager

Protected getDependencyManagerInstance

Parameters

options: TypeScriptOptions

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<TypeScriptOptions, ConstrainedMetaModel>

Returns Promise<RenderOutput>

renderClass

Parameters

model: ConstrainedObjectModel

inputModel: InputMetaModel

Optional enumType?: "enum" | "union"

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

Optional mapType?: "map" | "record" | "indexedObject"

Optional modelType?: "class" | "interface"

Optional moduleSystem?: TypeScriptModuleSystemType

`Optional` enumType?: "enum" | "union"

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

`Optional` mapType?: "map" | "record" | "indexedObject"

`Optional` modelType?: "class" | "interface"

`Optional` moduleSystem?: TypeScriptModuleSystemType

`Optional` rawPropertyNames?: boolean

`Optional` renderTypes?: boolean

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

`Optional` useJavascriptReservedKeywords?: boolean

`Readonly` languageName

`Readonly` options

`Static` defaultCompleteModelOptions

`Static` defaultOptions

`Optional` enumType?: "enum" | "union"

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

`Optional` mapType?: "map" | "record" | "indexedObject"

`Optional` modelType?: "class" | "interface"

`Optional` moduleSystem?: TypeScriptModuleSystemType

`Optional` rawPropertyNames?: boolean

`Optional` renderTypes?: boolean

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

`Optional` useJavascriptReservedKeywords?: boolean

`Protected` getDependencyManagerInstance

`Protected` getPresets

`Protected` processInput

`Optional` enumType?: "enum" | "union"

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

`Optional` mapType?: "map" | "record" | "indexedObject"

`Optional` modelType?: "class" | "interface"

`Optional` moduleSystem?: TypeScriptModuleSystemType

`Optional` rawPropertyNames?: boolean

`Optional` renderTypes?: boolean

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

`Optional` useJavascriptReservedKeywords?: boolean

`Optional` enumType?: "enum" | "union"

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

`Optional` mapType?: "map" | "record" | "indexedObject"

`Optional` modelType?: "class" | "interface"

`Optional` moduleSystem?: TypeScriptModuleSystemType

`Optional` rawPropertyNames?: boolean

`Optional` renderTypes?: boolean

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

`Optional` useJavascriptReservedKeywords?: boolean

`Optional` options: Partial<TypeScriptOptions>

`Optional` enumType?: "enum" | "union"

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

`Optional` mapType?: "map" | "record" | "indexedObject"

`Optional` modelType?: "class" | "interface"

`Optional` moduleSystem?: TypeScriptModuleSystemType

`Optional` rawPropertyNames?: boolean

`Optional` renderTypes?: boolean