Skip to main content
Version: 4.4

Interface: EntityProperty<T>#

core.EntityProperty

Type parameters#

NameTypeDefault
TAnyEntity<T>any

Hierarchy#

  • EntityProperty

Properties#

array#

Optional array: undefined | 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: undefined | 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: undefined | null | string | number | boolean

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


defaultRaw#

Optional defaultRaw: undefined | string

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


eager#

Optional eager: undefined | boolean

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


embeddable#

embeddable: Constructor<T>

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


embedded#

Optional embedded: undefined | [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>

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


enum#

Optional enum: undefined | boolean

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


fieldNameRaw#

Optional fieldNameRaw: undefined | string

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


fieldNames#

fieldNames: string[]

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


fixedOrder#

Optional fixedOrder: undefined | boolean

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


fixedOrderColumn#

Optional fixedOrderColumn: undefined | string

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


formula#

Optional formula: undefined | (alias: string) => string

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


getter#

Optional getter: undefined | boolean

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


getterName#

Optional getterName: undefined | keyof T

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


hidden#

Optional hidden: undefined | boolean

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


index#

Optional index: undefined | string | boolean

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


inherited#

Optional inherited: undefined | 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: undefined | (string | number)[]

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


joinColumns#

joinColumns: string[]

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


lazy#

Optional lazy: undefined | boolean

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


length#

Optional length: any

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


mapToPk#

Optional mapToPk: undefined | 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: undefined | boolean

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


object#

Optional object: undefined | boolean

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


onCreate#

Optional onCreate: undefined | (entity: T) => any

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


onDelete#

Optional onDelete: undefined | string

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


onUpdate#

Optional onUpdate: undefined | (entity: T) => any

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


onUpdateIntegrity#

Optional onUpdateIntegrity: undefined | string

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


orderBy#

Optional orderBy: undefined | { [field: string]: QueryOrder; }

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


orphanRemoval#

Optional orphanRemoval: undefined | boolean

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


owner#

owner: boolean

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


persist#

Optional persist: undefined | boolean

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


pivotTable#

pivotTable: string

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


prefix#

Optional prefix: undefined | 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: undefined | string

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


serializedPrimaryKey#

serializedPrimaryKey: boolean

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


serializer#

Optional serializer: undefined | (value: any) => any

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


setter#

Optional setter: undefined | boolean

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


strategy#

Optional strategy: undefined | SELECT_IN | JOINED

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


targetMeta#

Optional targetMeta: undefined | EntityMetadata<any>

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


type#

type: string

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


unique#

Optional unique: undefined | string | boolean

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


unsigned#

unsigned: boolean

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


userDefined#

Optional userDefined: undefined | boolean

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


version#

Optional version: undefined | boolean

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


wrappedReference#

Optional wrappedReference: undefined | boolean

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

Last updated on by Martin Adámek