Class: EntityMetadata<T, T>

Type parameters

Name	Type	Default
T	AnyEntity<T>	any
T	AnyEntity<T>	any

Hierarchy

• EntityMetadata

Constructors

constructor

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

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

Parameters:

Name	Type	Default value
meta	Partial<EntityMetadata>	{}

Returns: EntityMetadata

Properties

abstract

• abstract: boolean

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

---

class

• class: Constructor<T>

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

---

className

• className: string

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

---

collection

• collection: string

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

---

comment

• Optional comment: string

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

---

comparableProps

• comparableProps: EntityProperty<T>[]

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

---

compositePK

• compositePK: boolean

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

---

constructorParams

• constructorParams: string[]

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

---

customRepository

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

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

---

discriminatorColumn

• Optional discriminatorColumn: string

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

---

discriminatorMap

• Optional discriminatorMap: Dictionary<string>

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

---

discriminatorValue

• Optional discriminatorValue: string

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

---

embeddable

• embeddable: boolean

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

---

extends

• extends: string

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

---

filters

• filters: Dictionary<FilterDef<T>>

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

---

hooks

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

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

---

hydrateProps

• hydrateProps: EntityProperty<T>[]

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

---

indexes

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

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

---

name

• Optional name: string

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

---

path

• path: string

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

---

pivotTable

• pivotTable: boolean

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

---

primaryKeys

• primaryKeys: keyof T & string[]

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

---

properties

• properties: {}

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

---

propertyOrder

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

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

---

props

• props: EntityProperty<T>[]

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

---

prototype

• prototype: T

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

---

readonly

• Optional readonly: boolean

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

---

relations

• relations: EntityProperty<T>[]

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

---

root

• root: EntityMetadata<T>

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

---

selfReferencing

• Optional selfReferencing: boolean

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

---

serializedPrimaryKey

• serializedPrimaryKey: keyof T & string

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

---

tableName

• tableName: string

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

---

toJsonParams

• toJsonParams: string[]

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

---

uniques

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

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

---

useCache

• useCache: boolean

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

---

versionProperty

• versionProperty: keyof T & string

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

Methods

addProperty

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

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

Parameters:

Name	Type	Default value
prop	EntityProperty<T>	-
sync	boolean	true

Returns: void

---

initIndexes

▸ PrivateinitIndexes(prop: EntityProperty<T>): void

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

Parameters:

Name	Type
prop	EntityProperty<T>

Returns: void

---

removeProperty

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

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

Parameters:

Name	Type	Default value
name	string	-
sync	boolean	true

Returns: void

---

sync

▸ sync(initIndexes?: boolean): void

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

Parameters:

Name	Type	Default value
initIndexes	boolean	false

Returns: void