EntityMetadata <T>
Index
Constructors
Properties
- abstract
- bidirectionalRelations
- checks
- class
- className
- collection
- comment
- comparableProps
- compositePK
- concurrencyCheckKeys
- constructorParams
- definedProperties
- discriminatorColumn
- discriminatorMap
- discriminatorValue
- embeddable
- expression
- extends
- filters
- forceConstructor
- getterProps
- 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
Accessors
Methods
Constructors
constructor
Type parameters
- T = any
Parameters
meta: Partial<EntityMetadata<any>> = {}
Returns EntityMetadata<T>
Properties
abstract
bidirectionalRelations
checks
class
className
collection
optionalcomment
comparableProps
compositePK
concurrencyCheckKeys
constructorParams
definedProperties
optionaldiscriminatorColumn
optionaldiscriminatorMap
optionaldiscriminatorValue
embeddable
optionalexpression
extends
filters
forceConstructor
getterProps
optionalhasUniqueProps
hooks
Type declaration
afterCreate: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
afterDelete: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
afterFlush: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
afterTransactionCommit: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
afterTransactionRollback: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
afterTransactionStart: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
afterUpdate: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
afterUpsert: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
beforeCreate: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
beforeDelete: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
beforeFlush: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
beforeTransactionCommit: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
beforeTransactionRollback: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
beforeTransactionStart: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
beforeUpdate: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
beforeUpsert: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
onFlush: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
onInit: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
onLoad: undefined | (undefined | keyof T | (args: EventArgs<T>) => void | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: EventArgs<T>) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: FlushEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void> | (args: TransactionEventArgs) => void | Promise<void>)[]
hydrateProps
indexes
optionalname
path
optionalpivotTable
optionalpolymorphs
primaryKeys
properties
readonlypropertyOrder
props
prototype
optionalreadonly
referencingProperties
relations
repository
Type declaration
Returns EntityClass<EntityRepository<any>>
optionalrepositoryClass
root
optionalschema
optionalselfReferencing
serializedPrimaryKey
simplePK
tableName
toJsonParams
trackingProps
uniqueProps
uniques
useCache
versionProperty
optionalvirtual
Accessors
tableName
Returns string
Parameters
name: string
Returns void
Methods
addProperty
Parameters
prop: Partial<EntityProperty<T, any>>
sync: boolean = true
Returns void
getPrimaryProps
Returns EntityProperty<T, any>[]
removeProperty
Parameters
name: string
sync: boolean = true
Returns void
sync
Parameters
initIndexes: boolean = false
Returns void