Version: 4.3

Class: EntityMetadata<T, T>

Type parameters#

NameTypeDefault
TAnyEntity<T>any
TAnyEntity<T>any

Hierarchy#

  • EntityMetadata

Constructors#

constructor#

+ new EntityMetadata(meta?: Partial<EntityMetadata>): EntityMetadata

Defined in packages/core/src/typings.ts:190

Parameters:#

NameTypeDefault value
metaPartial<EntityMetadata>{}

Returns: EntityMetadata

Properties#

abstract#

abstract: boolean

Defined in packages/core/src/typings.ts:305


class#

class: Constructor<T>

Defined in packages/core/src/typings.ts:304


className#

className: string

Defined in packages/core/src/typings.ts:278


collection#

collection: string

Defined in packages/core/src/typings.ts:288


comment#

Optional comment: string

Defined in packages/core/src/typings.ts:308


comparableProps#

comparableProps: EntityProperty<T>[]

Defined in packages/core/src/typings.ts:297


compositePK#

compositePK: boolean

Defined in packages/core/src/typings.ts:291


constructorParams#

constructorParams: string[]

Defined in packages/core/src/typings.ts:285


customRepository#

customRepository: () => Constructor<EntityRepository<T>>

Defined in packages/core/src/typings.ts:301


discriminatorColumn#

Optional discriminatorColumn: string

Defined in packages/core/src/typings.ts:281


discriminatorMap#

Optional discriminatorMap: Dictionary<string>

Defined in packages/core/src/typings.ts:283


discriminatorValue#

Optional discriminatorValue: string

Defined in packages/core/src/typings.ts:282


embeddable#

embeddable: boolean

Defined in packages/core/src/typings.ts:284


extends#

extends: string

Defined in packages/core/src/typings.ts:287


filters#

filters: Dictionary<FilterDef<T>>

Defined in packages/core/src/typings.ts:307


hooks#

hooks: Partial<Record<keyof typeof EventType, string & keyof T[]>>

Defined in packages/core/src/typings.ts:302


hydrateProps#

hydrateProps: EntityProperty<T>[]

Defined in packages/core/src/typings.ts:298


indexes#

indexes: { name?: string ; options?: Dictionary ; properties: keyof T & string | keyof T & string[] ; type?: string }[]

Defined in packages/core/src/typings.ts:299


name#

Optional name: string

Defined in packages/core/src/typings.ts:277


path#

path: string

Defined in packages/core/src/typings.ts:289


pivotTable#

pivotTable: boolean

Defined in packages/core/src/typings.ts:280


primaryKeys#

primaryKeys: keyof T & string[]

Defined in packages/core/src/typings.ts:290


properties#

properties: {}

Defined in packages/core/src/typings.ts:294


propertyOrder#

Readonly propertyOrder: Map<string, number> = new Map<string, number>()

Defined in packages/core/src/typings.ts:190


props#

props: EntityProperty<T>[]

Defined in packages/core/src/typings.ts:295


prototype#

prototype: T

Defined in packages/core/src/typings.ts:303


readonly#

Optional readonly: boolean

Defined in packages/core/src/typings.ts:310


relations#

relations: EntityProperty<T>[]

Defined in packages/core/src/typings.ts:296


root#

root: EntityMetadata<T>

Defined in packages/core/src/typings.ts:311


selfReferencing#

Optional selfReferencing: boolean

Defined in packages/core/src/typings.ts:309


serializedPrimaryKey#

serializedPrimaryKey: keyof T & string

Defined in packages/core/src/typings.ts:293


tableName#

tableName: string

Defined in packages/core/src/typings.ts:279


toJsonParams#

toJsonParams: string[]

Defined in packages/core/src/typings.ts:286


uniques#

uniques: { name?: string ; options?: Dictionary ; properties: keyof T & string | keyof T & string[] }[]

Defined in packages/core/src/typings.ts:300


useCache#

useCache: boolean

Defined in packages/core/src/typings.ts:306


versionProperty#

versionProperty: keyof T & string

Defined in packages/core/src/typings.ts:292

Methods#

addProperty#

addProperty(prop: EntityProperty<T>, sync?: boolean): void

Defined in packages/core/src/typings.ts:203

Parameters:#

NameTypeDefault value
propEntityProperty<T>-
syncbooleantrue

Returns: void


getPrimaryProps#

getPrimaryProps(): EntityProperty<T>[]

Defined in packages/core/src/typings.ts:223

Returns: EntityProperty<T>[]


initIndexes#

PrivateinitIndexes(prop: EntityProperty<T>): void

Defined in packages/core/src/typings.ts:246

Parameters:#

NameType
propEntityProperty<T>

Returns: void


removeProperty#

removeProperty(name: string, sync?: boolean): void

Defined in packages/core/src/typings.ts:213

Parameters:#

NameTypeDefault value
namestring-
syncbooleantrue

Returns: void


sync#

sync(initIndexes?: boolean): void

Defined in packages/core/src/typings.ts:227

Parameters:#

NameTypeDefault value
initIndexesbooleanfalse

Returns: void

Last updated on by Renovate Bot