Version: 4.5

Interface: EntityProperty<T>#

core.EntityProperty

Type parameters#

Name	Type	Default
`T`	AnyEntity<T>	any

Properties#

array#

• Optional array: boolean

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

cascade#

• cascade: Cascade[]

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

columnTypes#

• columnTypes: string[]

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

comment#

• Optional comment: string

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

customType#

• customType: Type<any, any>

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

default#

• Optional default: null | string | number | boolean

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

defaultRaw#

• Optional defaultRaw: string

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

eager#

• Optional eager: boolean

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

embeddable#

• embeddable: Constructor<T>

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

embedded#

• Optional embedded: [string, string]

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

embeddedProps#

• embeddedProps: Dictionary<EntityProperty<any>>

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

entity#

• entity: () => EntityName<T>

Type declaration:#

▸ (): EntityName<T>

Returns: EntityName<T>

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

enum#

• Optional enum: boolean

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

fieldNameRaw#

• Optional fieldNameRaw: string

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

fieldNames#

• fieldNames: string[]

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

fixedOrder#

• Optional fixedOrder: boolean

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

fixedOrderColumn#

• Optional fixedOrderColumn: string

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

formula#

• Optional formula: (alias: string) => string

Type declaration:#

▸ (alias: string): string

Parameters:#

Name	Type
`alias`	string

Returns: string

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

getter#

• Optional getter: boolean

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

getterName#

• Optional getterName: keyof T

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

hidden#

• Optional hidden: boolean

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

index#

• Optional index: string | boolean

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

inherited#

• Optional inherited: boolean

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

inverseJoinColumns#

• inverseJoinColumns: string[]

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

inversedBy#

• inversedBy: string

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

items#

• Optional items: (string | number)[]

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

joinColumns#

• joinColumns: string[]

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

lazy#

• Optional lazy: boolean

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

length#

• Optional length: any

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

mapToPk#

• Optional mapToPk: boolean

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

mappedBy#

• mappedBy: string

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

name#

• name: string & keyof T

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

nullable#

• Optional nullable: boolean

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

object#

• Optional object: boolean

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

onCreate#

• Optional onCreate: (entity: T) => any

Type declaration:#

▸ (entity: T): any

Parameters:#

Name	Type
`entity`	T

Returns: any

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

onDelete#

• Optional onDelete: string

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

onUpdate#

• Optional onUpdate: (entity: T) => any

Type declaration:#

▸ (entity: T): any

Parameters:#

Name	Type
`entity`	T

Returns: any

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

onUpdateIntegrity#

• Optional onUpdateIntegrity: string

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

orderBy#

• Optional orderBy: object

Type declaration:#

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

orphanRemoval#

• Optional orphanRemoval: boolean

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

owner#

• owner: boolean

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

persist#

• Optional persist: boolean

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

pivotTable#

• pivotTable: string

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

prefix#

• Optional prefix: string | boolean

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

primary#

• primary: boolean

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

reference#

• reference: ReferenceType

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

referencedColumnNames#

• referencedColumnNames: string[]

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

referencedPKs#

• referencedPKs: string[]

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

referencedTableName#

• referencedTableName: string

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

serializedName#

• Optional serializedName: string

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

serializedPrimaryKey#

• serializedPrimaryKey: boolean

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

serializer#

• Optional serializer: (value: any) => any

Type declaration:#

▸ (value: any): any

Parameters:#

Name	Type
`value`	any

Returns: any

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

setter#

• Optional setter: boolean

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

strategy#

• Optional strategy: LoadStrategy

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

targetMeta#

• Optional targetMeta: EntityMetadata<any>

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

type#

• type: string

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

unique#

• Optional unique: string | boolean

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

unsigned#

• unsigned: boolean

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

userDefined#

• Optional userDefined: boolean

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

version#

• Optional version: boolean

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

wrappedReference#

• Optional wrappedReference: boolean

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