Class JavaScriptGenerator

constructor

• new JavaScriptGenerator(options?): JavaScriptGenerator

• 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.

      1. It can be used to provide a factory for generate functions
      2. 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 JavaScriptGenerator

Static defaultCompleteModelOptions

Static defaultOptions

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.

      1. It can be used to provide a factory for generate functions
      2. 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

getDependencyManager

• getDependencyManager(options): JavaScriptDependencyManager

• Wrapper to get an instance of the dependency manager

  Parameters

  • options: JavaScriptOptions

  Returns JavaScriptDependencyManager

render

• render(args): Promise<RenderOutput>

• Parameters

  • args: AbstractGeneratorRenderArgs<JavaScriptOptions, ConstrainedMetaModel>

  Returns Promise<RenderOutput>

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.

      1. It can be used to provide a factory for generate functions
      2. 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>

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>

splitMetaModel

• splitMetaModel(model): MetaModel[]

• Parameters

  • model: MetaModel

  Returns MetaModel[]

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.

      1. It can be used to provide a factory for generate functions
      2. 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