Class ModelDefinitionUtils

Model definition utils.

Hierarchy

  • Service
    • ModelDefinitionUtils

Constructors

constructor

Properties

container

Methods

addService convertColumnNamesToPropertyNames convertPropertyNamesToColumnNames excludeObjectKeysByRelationNames getColumnNameByPropertyName getDataTypeByPropertyName getDataTypeFromPropertyDefinition getDefaultPropertyValue getOwnPropertiesDefinitionOfPrimaryKeys getOwnPropertiesDefinitionWithoutPrimaryKeys getOwnRelationsDefinition getPrimaryKeyAsColumnName getPrimaryKeyAsPropertyName getPropertiesDefinitionInBaseModelHierarchy getRelationDefinitionByName getRelationsDefinitionInBaseModelHierarchy getService getTableNameByModelName hasService setDefaultValuesToEmptyProperties useService

Constructors

constructor

  • new ModelDefinitionUtils(container?): ModelDefinitionUtils

  • Constructor.

    Parameters

    • Optional container: ServiceContainer

    Returns ModelDefinitionUtils

Properties

container

container: ServiceContainer

Container.

Methods

addService

  • addService<T>(ctor, ...args): this

  • Add service.

    Type Parameters

    • T extends object

    Parameters

    • ctor: Constructor<T>
    • Rest ...args: any[]

    Returns this

convertColumnNamesToPropertyNames

  • convertColumnNamesToPropertyNames(modelName, tableData): ModelData

  • Convert column names to property names.

    Parameters

    Returns ModelData

convertPropertyNamesToColumnNames

  • convertPropertyNamesToColumnNames(modelName, modelData): ModelData

  • Convert property names to column names.

    Parameters

    Returns ModelData

excludeObjectKeysByRelationNames

  • excludeObjectKeysByRelationNames<T>(modelName, modelData): Partial<T>

  • Exclude object keys by relation names.

    Type Parameters

    Parameters

    • modelName: string
    • modelData: T

    Returns Partial<T>

getColumnNameByPropertyName

  • getColumnNameByPropertyName(modelName, propertyName): string

  • Get column name by property name.

    Parameters

    • modelName: string
    • propertyName: string

    Returns string

getDataTypeByPropertyName

  • getDataTypeByPropertyName(modelName, propertyName): DataType

  • Get data type by property name.

    Parameters

    • modelName: string
    • propertyName: string

    Returns DataType

getDataTypeFromPropertyDefinition

  • getDataTypeFromPropertyDefinition(propDef): DataType

  • Get data type from property definition.

    Parameters

    Returns DataType

getDefaultPropertyValue

  • getDefaultPropertyValue(modelName, propertyName): unknown

  • Get default property value.

    Parameters

    • modelName: string
    • propertyName: string

    Returns unknown

getOwnPropertiesDefinitionOfPrimaryKeys

  • getOwnPropertiesDefinitionOfPrimaryKeys(modelName): PropertyDefinitionMap

  • Get own properties definition of primary keys.

    Parameters

    • modelName: string

    Returns PropertyDefinitionMap

getOwnPropertiesDefinitionWithoutPrimaryKeys

  • getOwnPropertiesDefinitionWithoutPrimaryKeys(modelName): PropertyDefinitionMap

  • Get own properties definition without primary keys.

    Parameters

    • modelName: string

    Returns PropertyDefinitionMap

getOwnRelationsDefinition

getPrimaryKeyAsColumnName

  • getPrimaryKeyAsColumnName(modelName): string

  • Get primary key as column name.

    Parameters

    • modelName: string

    Returns string

getPrimaryKeyAsPropertyName

  • getPrimaryKeyAsPropertyName(modelName): string

  • Get primary key as property name.

    Parameters

    • modelName: string

    Returns string

getPropertiesDefinitionInBaseModelHierarchy

  • getPropertiesDefinitionInBaseModelHierarchy(modelName): PropertyDefinitionMap

  • Get properties definition in base model hierarchy.

    Parameters

    • modelName: string

    Returns PropertyDefinitionMap

getRelationDefinitionByName

  • getRelationDefinitionByName(modelName, relationName): RelationDefinition

  • Get relation definition by name.

    Parameters

    • modelName: string
    • relationName: string

    Returns RelationDefinition

getRelationsDefinitionInBaseModelHierarchy

  • getRelationsDefinitionInBaseModelHierarchy(modelName): RelationDefinitionMap

  • Get relations definition in base model hierarchy.

    Parameters

    • modelName: string

    Returns RelationDefinitionMap

getService

  • getService<T>(ctor, ...args): T

  • Get service.

    Type Parameters

    • T extends object

    Parameters

    • ctor: Constructor<T>
    • Rest ...args: any[]

    Returns T

getTableNameByModelName

  • getTableNameByModelName(modelName): string

  • Get table name by model name.

    Parameters

    • modelName: string

    Returns string

hasService

  • hasService<T>(ctor): boolean

  • Has service.

    Type Parameters

    • T extends object

    Parameters

    • ctor: Constructor<T>

    Returns boolean

setDefaultValuesToEmptyProperties

  • setDefaultValuesToEmptyProperties<T>(modelName, modelData, onlyProvidedProperties?): T

  • Set default values to empty properties.

    Type Parameters

    Parameters

    • modelName: string
    • modelData: T
    • Optional onlyProvidedProperties: boolean

    Returns T

useService

  • useService<T>(ctor, ...args): this

  • Use service.

    Type Parameters

    • T extends object

    Parameters

    • ctor: Constructor<T>
    • Rest ...args: any[]

    Returns this

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc