Class LdkitObjectModelTypeGenerator

The LdkitObjectModelTypeGenerator class is responsible for rendering a TypeScript object types based on LDkit schema.

Hierarchy (View Summary)

TemplateConsumer<LdkitObjectModelTypeTemplate>
- LdkitObjectModelTypeGenerator

Index

Constructors

Properties

_filePath _templatePath _templateRenderer

Methods

getTemplatePageTitle processTemplate

Constructors

constructor

new LdkitObjectModelTypeGenerator(
outputFilePath: string,
): LdkitObjectModelTypeGenerator
Parameters
- outputFilePath: string
Returns LdkitObjectModelTypeGenerator
Overrides TemplateConsumer.constructor
- Defined in data-layer/template-generators/ldkit/object-model-type-generator.ts:33

Properties

`Protected` `Readonly`_filePath

_filePath: string

`Protected` `Readonly`_templatePath

_templatePath: string

`Protected` `Readonly`_templateRenderer

_templateRenderer: TemplateGenerator<LdkitObjectModelTypeTemplate>

Methods

`Protected`getTemplatePageTitle

getTemplatePageTitle(
pageTitleLanguageString: undefined | LanguageString,
languageId?: string,
): null | string
Retrieves the title of a template page in the specified language.
Parameters
- pageTitleLanguageString: undefined | LanguageString
  An object containing language-specific titles.
- languageId: string = "en"
  The language identifier for the title. Defaults to "en", if not provided.
Returns null | string
The page title in the specified language, or the first available language if not found.
Inherited from TemplateConsumer.getTemplatePageTitle
- Defined in engine/templates/template-consumer.ts:44

processTemplate

processTemplate(
dependencies: LdkitObjectModelDependencyMap,
): Promise<LayerArtifact>
Processes the template to render an aggregate type based on its LDkit schema.
Parameters
- dependencies: LdkitObjectModelDependencyMap
  An object containing the dependencies required for generating the object model type.
Returns Promise<LayerArtifact>
A promise that resolves to a LayerArtifact containing the generated object type definition.
Overrides TemplateConsumer.processTemplate
- Defined in data-layer/template-generators/ldkit/object-model-type-generator.ts:185