Class JavaScriptFileGenerator

Abstract file generator which each file generator much implement.

Hierarchy

JavaScriptGenerator
- JavaScriptFileGenerator

Implements

AbstractFileGenerator<JavaScriptRenderCompleteModelOptions>

Index

Constructors

constructor

new JavaScriptFileGenerator(options?): JavaScriptFileGenerator
Parameters
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<JavaScriptOptions> | undefined; enumValue?: EnumValueConstraint<JavaScriptOptions> | 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; };
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      moduleSystem?: "CJS" | "ESM";
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | 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, JavaScriptOptions, JavaScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<JavaScriptOptions> | undefined; enumValue?: EnumValueConstraint<JavaScriptOptions> | 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; }
  - 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 moduleSystem?: "CJS" | "ESM"
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | 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, JavaScriptOptions, JavaScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns JavaScriptFileGenerator
Inherited from JavaScriptGenerator.constructor
- Defined in src/generators/javascript/JavaScriptGenerator.ts:75

Properties

`Readonly` languageName

languageName: string

`Readonly` options

options: JavaScriptOptions

`Static` defaultCompleteModelOptions

defaultCompleteModelOptions: JavaScriptRenderCompleteModelOptions = {}

`Static` defaultOptions

defaultOptions: JavaScriptOptions = ...

Methods

constrainToMetaModel

constrainToMetaModel(model, options): ConstrainedMetaModel
Parameters
- model: MetaModel
- options: {
      constraints?: { enumKey?: EnumKeyConstraint<JavaScriptOptions> | undefined; enumValue?: EnumValueConstraint<JavaScriptOptions> | 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; };
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      moduleSystem?: "CJS" | "ESM";
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | 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, JavaScriptOptions, JavaScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<JavaScriptOptions> | undefined; enumValue?: EnumValueConstraint<JavaScriptOptions> | 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; }
  - 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 moduleSystem?: "CJS" | "ESM"
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | 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, JavaScriptOptions, JavaScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns ConstrainedMetaModel
Inherited from JavaScriptGenerator.constrainToMetaModel
- Defined in src/generators/javascript/JavaScriptGenerator.ts:196

generate

generate(input): Promise<OutputModel[]>
Generates a scattered model where dependencies and rendered results are separated.
Parameters
- input: any
Returns Promise<OutputModel[]>
Inherited from JavaScriptGenerator.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<JavaScriptRenderCompleteModelOptions>
Returns Promise<OutputModel[]>
Inherited from JavaScriptGenerator.generateCompleteModels
- Defined in src/generators/AbstractGenerator.ts:198

generateToFiles

generateToFiles(input, outputDirectory, options?, ensureFilesWritten?): Promise<OutputModel[]>
Generates all the models to an output directory each model with their own separate files.
Parameters
- input: any
- outputDirectory: string
  
  where you want the models generated to
- Optional options: JavaScriptRenderCompleteModelOptions
- ensureFilesWritten: boolean = false
  
  verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
Returns Promise<OutputModel[]>
Implementation of AbstractFileGenerator.generateToFiles
- Defined in src/generators/javascript/JavaScriptFileGenerator.ts:19

getDependencyManager

getDependencyManager(options): JavaScriptDependencyManager
Wrapper to get an instance of the dependency manager
Parameters
- options: JavaScriptOptions
Returns JavaScriptDependencyManager
Inherited from JavaScriptGenerator.getDependencyManager
- Defined in src/generators/javascript/JavaScriptGenerator.ts:102

`Protected` getDependencyManagerInstance

getDependencyManagerInstance(options): AbstractDependencyManager
This function returns an instance of the dependency manager which is either a factory or an instance.
Parameters
- options: JavaScriptOptions
Returns AbstractDependencyManager
Inherited from JavaScriptGenerator.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 JavaScriptGenerator.getPresets
- Defined in src/generators/AbstractGenerator.ts:280

process

process(input): Promise<InputMetaModel>
Parameters
- input: Record<string, unknown>
Returns Promise<InputMetaModel>
Inherited from JavaScriptGenerator.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 JavaScriptGenerator.processInput
- Defined in src/generators/AbstractGenerator.ts:259

render

render(args): Promise<RenderOutput>
Parameters
- args: AbstractGeneratorRenderArgs<JavaScriptOptions, ConstrainedMetaModel>
Returns Promise<RenderOutput>
Inherited from JavaScriptGenerator.render
- Defined in src/generators/javascript/JavaScriptGenerator.ts:162

renderClass

renderClass(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedObjectModel
- inputModel: InputMetaModel
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<JavaScriptOptions> | undefined; enumValue?: EnumValueConstraint<JavaScriptOptions> | 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; };
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      moduleSystem?: "CJS" | "ESM";
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | 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, JavaScriptOptions, JavaScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<JavaScriptOptions> | undefined; enumValue?: EnumValueConstraint<JavaScriptOptions> | 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; }
  - 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 moduleSystem?: "CJS" | "ESM"
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | 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, JavaScriptOptions, JavaScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns Promise<RenderOutput>
Inherited from JavaScriptGenerator.renderClass
- Defined in src/generators/javascript/JavaScriptGenerator.ts:217

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<JavaScriptOptions, JavaScriptRenderCompleteModelOptions>
Returns Promise<RenderOutput>
Inherited from JavaScriptGenerator.renderCompleteModel
- Defined in src/generators/javascript/JavaScriptGenerator.ts:118

splitMetaModel

splitMetaModel(model): MetaModel[]
Parameters
- model: MetaModel
Returns MetaModel[]
Inherited from JavaScriptGenerator.splitMetaModel
- Defined in src/generators/javascript/JavaScriptGenerator.ts:188

`Static` getJavaScriptOptions

getJavaScriptOptions(options?): JavaScriptOptions
Returns the JavaScript options by merging custom options with default ones.
Parameters
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<JavaScriptOptions> | undefined; enumValue?: EnumValueConstraint<JavaScriptOptions> | 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; };
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      moduleSystem?: "CJS" | "ESM";
      presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | 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, JavaScriptOptions, JavaScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<JavaScriptOptions> | undefined; enumValue?: EnumValueConstraint<JavaScriptOptions> | 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; }
  - 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 moduleSystem?: "CJS" | "ESM"
  - Optional presets?: (undefined | ({ class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | undefined; }) | ({ preset?: { class?: { ctor?: ((args: PresetArgs<ClassRenderer, any, ConstrainedObjectModel>) => string | Promise<string>) | undefined; ... 4 more ...; additionalContent?: ((args: PresetArgs<...>) => string | Promise<...>) | undefined; } | 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, JavaScriptOptions, JavaScriptDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns JavaScriptOptions
Inherited from JavaScriptGenerator.getJavaScriptOptions
- Defined in src/generators/javascript/JavaScriptGenerator.ts:83

Class JavaScriptFileGenerator

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

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

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

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

Optional moduleSystem?: "CJS" | "ESM"

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

Returns JavaScriptFileGenerator

Properties

Readonly languageName

Readonly options

Static defaultCompleteModelOptions

Static defaultOptions

Methods

constrainToMetaModel

Parameters

model: MetaModel

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

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

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

Optional moduleSystem?: "CJS" | "ESM"

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

Returns ConstrainedMetaModel

generate

Parameters

input: any

Returns Promise<OutputModel[]>

generateCompleteModels

Parameters

input: any

completeOptions: Partial<JavaScriptRenderCompleteModelOptions>

Returns Promise<OutputModel[]>

generateToFiles

Parameters

input: any

outputDirectory: string

Optional options: JavaScriptRenderCompleteModelOptions

ensureFilesWritten: boolean = false

Returns Promise<OutputModel[]>

getDependencyManager

Parameters

options: JavaScriptOptions

Returns JavaScriptDependencyManager

Protected getDependencyManagerInstance

Parameters

options: JavaScriptOptions

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

Returns Promise<RenderOutput>

renderClass

Parameters

model: ConstrainedObjectModel

inputModel: InputMetaModel

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

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

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

Optional moduleSystem?: "CJS" | "ESM"

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

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

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

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

`Optional` moduleSystem?: "CJS" | "ESM"

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

`Readonly` languageName

`Readonly` options

`Static` defaultCompleteModelOptions

`Static` defaultOptions

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

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

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

`Optional` moduleSystem?: "CJS" | "ESM"

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

`Optional` options: JavaScriptRenderCompleteModelOptions

`Protected` getDependencyManagerInstance

`Protected` getPresets

`Protected` processInput

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

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

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

`Optional` moduleSystem?: "CJS" | "ESM"

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

`Static` getJavaScriptOptions

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

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

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

`Optional` moduleSystem?: "CJS" | "ESM"

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