Class ModelGenerator

Base class for model generators.

Hierarchy

ModelGenerator
- MySQLModelGenerator

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ModelGenerator(tableFormatter: TableFormatter, columnFormatter: ColumnFormatter, relFormatter: RelationshipFormatter, pathHelper?: PathHelper): ModelGenerator

- Defined in modelgenerator/model-generator.ts:14
Initialize the model generator.

Parameters
- tableFormatter: TableFormatter
  
  A TableFormatter instance that is used to format the names of generated class entities.
- columnFormatter: ColumnFormatter
  
  A ColumnFormatter instance that is used for formatting property names in the generated class entities.
- relFormatter: RelationshipFormatter
  
  A RelationshipFormatter instances that is used to format relationship property names.
- Default value pathHelper: PathHelper = new PathHelper()
  
  A PathHelper instance for creating the entity directory.
Returns ModelGenerator

Properties

Protected columnFormatter

columnFormatter: ColumnFormatter

A ColumnFormatter instance that is used for formatting property names in the generated class entities.

Protected pathHelper

pathHelper: PathHelper

A PathHelper instance for creating the entity directory.

Protected relFormatter

relFormatter: RelationshipFormatter

A RelationshipFormatter instances that is used to format relationship property names.

Protected tableFormatter

tableFormatter: TableFormatter

A TableFormatter instance that is used to format the names of generated class entities.

Methods

Abstract generateModels

generateModels(dbName: string, entDir: string): Promise<ModelTable[]>

- Defined in modelgenerator/model-generator.ts:41
Generate models for the provided database.

Parameters
- dbName: string
  
  A database name. A model will be generated for each table in the database.
- entDir: string
  
  A path to which entity files will be saved.
Returns Promise<ModelTable[]>

An array of ModelTable. Calling ModelTable.toString will return the entity class definition.

writeModels

writeModels(models: ModelTable[], entDir: string): Promise<void>

- Defined in modelgenerator/model-generator.ts:48
Write an array of ModelTable to disk using entDir as the path.

Parameters
- models: ModelTable[]
  
  An array of ModelTable to write to disk.
- entDir: string
  
  The path to which models should be written.
Returns Promise<void>

Generated using TypeDoc