EntityMetadataWithProperties <TProperties, TPK, TBase>

Hierarchy

• Omit<Partial<EntityMetadata<InferEntityFromProperties<TProperties, TPK>>>, properties | extends | primaryKeys | hooks | discriminatorColumn | versionProperty | concurrencyCheckKeys | serializedPrimaryKey | indexes | uniques>
  • EntityMetadataWithProperties

Index

Properties

• abstract
• bidirectionalRelations
• checks
• class
• className
• collection
• comment
• comparableProps
• compositePK
• concurrencyCheckKeys
• constructorParams
• definedProperties
• discriminatorColumn
• discriminatorMap
• discriminatorValue
• embeddable
• expression
• extends
• filters
• forceConstructor
• getterProps
• hasTriggers
• hasUniqueProps
• hooks
• hydrateProps
• indexes
• name
• path
• pivotTable
• polymorphs
• primaryKeys
• properties
• propertyOrder
• props
• prototype
• readonly
• referencingProperties
• relations
• repository
• repositoryClass
• root
• schema
• selfReferencing
• serializedPrimaryKey
• simplePK
• tableName
• toJsonParams
• trackingProps
• uniqueProps
• uniques
• useCache
• versionProperty
• virtual

Methods

• addProperty
• createColumnMappingObject
• getPrimaryProp
• getPrimaryProps
• removeProperty
• sync

Properties

optionalinheritedabstract

abstract?: boolean

Inherited from Omit.abstract

optionalinheritedbidirectionalRelations

bidirectionalRelations?: EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>[]

Inherited from Omit.bidirectionalRelations

optionalinheritedchecks

checks?: CheckConstraint<InferEntityFromProperties<TProperties, TPK>>[]

Inherited from Omit.checks

optionalinheritedclass

class?: EntityClass<InferEntityFromProperties<TProperties, TPK>>

Inherited from Omit.class

optionalinheritedclassName

className?: string

Inherited from Omit.className

optionalinheritedcollection

collection?: string

Inherited from Omit.collection

optionalinheritedcomment

comment?: string

Inherited from Omit.comment

optionalinheritedcomparableProps

comparableProps?: EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>[]

Inherited from Omit.comparableProps

optionalinheritedcompositePK

compositePK?: boolean

Inherited from Omit.compositePK

optionalconcurrencyCheckKeys

concurrencyCheckKeys?: Set<keyof TProperties>

optionalinheritedconstructorParams

constructorParams?: EntityKey<InferEntityFromProperties<TProperties, TPK>, false>[]

Inherited from Omit.constructorParams

optionalinheriteddefinedProperties

definedProperties?: Dictionary<any>

Inherited from Omit.definedProperties

optionaldiscriminatorColumn

discriminatorColumn?: keyof TProperties

optionalinheriteddiscriminatorMap

discriminatorMap?: Dictionary<string>

Inherited from Omit.discriminatorMap

optionalinheriteddiscriminatorValue

discriminatorValue?: string | number

Inherited from Omit.discriminatorValue

optionalinheritedembeddable

embeddable?: boolean

Inherited from Omit.embeddable

optionalinheritedexpression

expression?: string | (em, where, options) => MaybePromise<string | object>

Inherited from Omit.expression

optionalextends

extends?: EntityName<TBase>

optionalinheritedfilters

filters?: Dictionary<FilterDef>

Inherited from Omit.filters

optionalinheritedforceConstructor

forceConstructor?: boolean

Inherited from Omit.forceConstructor

optionalinheritedgetterProps

getterProps?: EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>[]

Inherited from Omit.getterProps

optionalinheritedhasTriggers

hasTriggers?: boolean

Inherited from Omit.hasTriggers

optionalinheritedhasUniqueProps

hasUniqueProps?: boolean

Inherited from Omit.hasUniqueProps

optionalhooks

hooks?: DefineEntityHooks<InferEntityFromProperties<TProperties, TPK>>

optionalinheritedhydrateProps

hydrateProps?: EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>[]

Inherited from Omit.hydrateProps

optionalindexes

indexes?: { expression?: string | IndexCallback<InferEntityFromProperties<TProperties, TPK>>; name?: string; options?: Dictionary; properties?: keyof TProperties | keyof TProperties[]; type?: string }[]

name

name: string

Overrides Omit.name

optionalinheritedpath

path?: string

Inherited from Omit.path

optionalinheritedpivotTable

pivotTable?: boolean

Inherited from Omit.pivotTable

optionalinheritedpolymorphs

polymorphs?: EntityMetadata<any>[]

Inherited from Omit.polymorphs

optionalprimaryKeys

primaryKeys?: TPK & InferPrimaryKey<TProperties>[]

properties

properties: TProperties | (properties) => TProperties

optionalreadonlyinheritedpropertyOrder

propertyOrder?: Map<string, number> = ...

Inherited from Omit.propertyOrder

optionalinheritedprops

props?: EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>[]

Inherited from Omit.props

optionalinheritedprototype

prototype?: InferEntityFromProperties<TProperties, TPK>

Inherited from Omit.prototype

optionalinheritedreadonly

readonly?: boolean

Inherited from Omit.readonly

optionalinheritedreferencingProperties

referencingProperties?: { meta: EntityMetadata<InferEntityFromProperties<TProperties, TPK>>; prop: EntityProperty<InferEntityFromProperties<TProperties, TPK>, any> }[]

Inherited from Omit.referencingProperties

optionalinheritedrelations

relations?: EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>[]

Inherited from Omit.relations

optionalinheritedrepository

repository?: () => EntityClass<EntityRepository<any>>

Inherited from Omit.repository

Type declaration

• • (): EntityClass<EntityRepository<any>>

  • Returns EntityClass<EntityRepository<any>>

optionalinheritedrepositoryClass

repositoryClass?: string

Inherited from Omit.repositoryClass

optionalinheritedroot

root?: EntityMetadata<InferEntityFromProperties<TProperties, TPK>>

Inherited from Omit.root

optionalinheritedschema

schema?: string

Inherited from Omit.schema

optionalinheritedselfReferencing

selfReferencing?: boolean

Inherited from Omit.selfReferencing

optionalserializedPrimaryKey

serializedPrimaryKey?: keyof TProperties

optionalinheritedsimplePK

simplePK?: boolean

Inherited from Omit.simplePK

inheritedtableName

tableName: undefined | string

Inherited from Omit.tableName

optionalinheritedtoJsonParams

toJsonParams?: string[]

Inherited from Omit.toJsonParams

optionalinheritedtrackingProps

trackingProps?: EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>[]

Inherited from Omit.trackingProps

optionalinheriteduniqueProps

uniqueProps?: EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>[]

Inherited from Omit.uniqueProps

optionaluniques

uniques?: { deferMode?: DeferMode | immediate | deferred; expression?: string | IndexCallback<InferEntityFromProperties<TProperties, TPK>>; name?: string; options?: Dictionary; properties?: keyof TProperties | keyof TProperties[] }[]

optionalinheriteduseCache

useCache?: boolean

Inherited from Omit.useCache

optionalversionProperty

versionProperty?: keyof TProperties

optionalinheritedvirtual

virtual?: boolean

Inherited from Omit.virtual

Methods

optionalinheritedaddProperty

• addProperty(prop, sync): void

• Inherited from Omit.addProperty

  Parameters

  • prop: Partial<EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>>

  • sync: boolean = true

  Returns void

optionalinheritedcreateColumnMappingObject

• createColumnMappingObject(): Dictionary<any>

• Inherited from Omit.createColumnMappingObject

  Returns Dictionary<any>

optionalinheritedgetPrimaryProp

• getPrimaryProp(): EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>

• Inherited from Omit.getPrimaryProp

  Returns EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>

optionalinheritedgetPrimaryProps

• getPrimaryProps(flatten): EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>[]

• Inherited from Omit.getPrimaryProps

  Parameters

  • flatten: boolean = false

  Returns EntityProperty<InferEntityFromProperties<TProperties, TPK>, any>[]

optionalinheritedremoveProperty

• removeProperty(name, sync): void

• Inherited from Omit.removeProperty

  Parameters

  • name: string

  • sync: boolean = true

  Returns void

optionalinheritedsync

• sync(initIndexes): void

• Inherited from Omit.sync

  Parameters

  • initIndexes: boolean = false

  Returns void