Skip to main content
Version: Next

Interface: EntityProperty<T>

core.EntityProperty

Type parameters#

NameType
TT: AnyEntity<T> = any

Properties#

array#

Optional array: boolean

Defined in#

packages/core/src/typings.ts:177


autoincrement#

Optional autoincrement: boolean

Defined in#

packages/core/src/typings.ts:173


cascade#

cascade: Cascade[]

Defined in#

packages/core/src/typings.ts:208


columnTypes#

columnTypes: string[]

Defined in#

packages/core/src/typings.ts:171


comment#

Optional comment: string

Defined in#

packages/core/src/typings.ts:229


customType#

customType: Type<any, any>

Defined in#

packages/core/src/typings.ts:172


default#

Optional default: null | string | number | boolean

Defined in#

packages/core/src/typings.ts:185


defaultRaw#

Optional defaultRaw: string

Defined in#

packages/core/src/typings.ts:186


eager#

Optional eager: boolean

Defined in#

packages/core/src/typings.ts:204


embeddable#

embeddable: Constructor<T>

Defined in#

packages/core/src/typings.ts:190


embedded#

Optional embedded: [string, string]

Defined in#

packages/core/src/typings.ts:189


embeddedProps#

embeddedProps: Dictionary<EntityProperty<any>>

Defined in#

packages/core/src/typings.ts:191


entity#

entity: () => EntityName<T>

Type declaration#

▸ (): EntityName<T>

Returns#

EntityName<T>

Defined in#

packages/core/src/typings.ts:168


enum#

Optional enum: boolean

Defined in#

packages/core/src/typings.ts:201


fieldNameRaw#

Optional fieldNameRaw: string

Defined in#

packages/core/src/typings.ts:184


fieldNames#

fieldNames: string[]

Defined in#

packages/core/src/typings.ts:183


fixedOrder#

Optional fixedOrder: boolean

Defined in#

packages/core/src/typings.ts:219


fixedOrderColumn#

Optional fixedOrderColumn: string

Defined in#

packages/core/src/typings.ts:220


formula#

Optional formula: (alias: string) => string

Type declaration#

▸ (alias): string

Parameters#
NameType
aliasstring
Returns#

string

Defined in#

packages/core/src/typings.ts:187


getter#

Optional getter: boolean

Defined in#

packages/core/src/typings.ts:206


getterName#

Optional getterName: keyof T

Defined in#

packages/core/src/typings.ts:207


hidden#

Optional hidden: boolean

Defined in#

packages/core/src/typings.ts:200


index#

Optional index: string | boolean

Defined in#

packages/core/src/typings.ts:193


inherited#

Optional inherited: boolean

Defined in#

packages/core/src/typings.ts:196


inverseJoinColumns#

inverseJoinColumns: string[]

Defined in#

packages/core/src/typings.ts:223


inversedBy#

inversedBy: string

Defined in#

packages/core/src/typings.ts:216


items#

Optional items: (string | number)[]

Defined in#

packages/core/src/typings.ts:202


joinColumns#

joinColumns: string[]

Defined in#

packages/core/src/typings.ts:222


lazy#

Optional lazy: boolean

Defined in#

packages/core/src/typings.ts:176


length#

Optional length: number

Defined in#

packages/core/src/typings.ts:178


mapToPk#

Optional mapToPk: boolean

Defined in#

packages/core/src/typings.ts:198


mappedBy#

mappedBy: string

Defined in#

packages/core/src/typings.ts:217


name#

name: string & keyof T

Defined in#

packages/core/src/typings.ts:167


nullable#

Optional nullable: boolean

Defined in#

packages/core/src/typings.ts:195


object#

Optional object: boolean

Defined in#

packages/core/src/typings.ts:192


onCreate#

Optional onCreate: (entity: T) => any

Type declaration#

▸ (entity): any

Parameters#
NameType
entityT
Returns#

any

Defined in#

packages/core/src/typings.ts:210


onDelete#

Optional onDelete: string

Defined in#

packages/core/src/typings.ts:212


onUpdate#

Optional onUpdate: (entity: T) => any

Type declaration#

▸ (entity): any

Parameters#
NameType
entityT
Returns#

any

Defined in#

packages/core/src/typings.ts:211


onUpdateIntegrity#

Optional onUpdateIntegrity: string

Defined in#

packages/core/src/typings.ts:213


orderBy#

Optional orderBy: Object

Index signature#

▪ [field: string]: QueryOrder

Defined in#

packages/core/src/typings.ts:218


orphanRemoval#

Optional orphanRemoval: boolean

Defined in#

packages/core/src/typings.ts:209


owner#

owner: boolean

Defined in#

packages/core/src/typings.ts:215


persist#

Optional persist: boolean

Defined in#

packages/core/src/typings.ts:199


pivotTable#

pivotTable: string

Defined in#

packages/core/src/typings.ts:221


precision#

Optional precision: number

Defined in#

packages/core/src/typings.ts:179


prefix#

Optional prefix: string | boolean

Defined in#

packages/core/src/typings.ts:188


primary#

Optional primary: boolean

Defined in#

packages/core/src/typings.ts:174


reference#

reference: ReferenceType

Defined in#

packages/core/src/typings.ts:181


referencedColumnNames#

referencedColumnNames: string[]

Defined in#

packages/core/src/typings.ts:224


referencedPKs#

referencedPKs: string[]

Defined in#

packages/core/src/typings.ts:226


referencedTableName#

referencedTableName: string

Defined in#

packages/core/src/typings.ts:225


scale#

Optional scale: number

Defined in#

packages/core/src/typings.ts:180


serializedName#

Optional serializedName: string

Defined in#

packages/core/src/typings.ts:228


serializedPrimaryKey#

serializedPrimaryKey: boolean

Defined in#

packages/core/src/typings.ts:175


serializer#

Optional serializer: (value: any) => any

Type declaration#

▸ (value): any

Parameters#
NameType
valueany
Returns#

any

Defined in#

packages/core/src/typings.ts:227


setter#

Optional setter: boolean

Defined in#

packages/core/src/typings.ts:205


strategy#

Optional strategy: LoadStrategy

Defined in#

packages/core/src/typings.ts:214


targetMeta#

Optional targetMeta: EntityMetadata<any>

Defined in#

packages/core/src/typings.ts:170


type#

type: string

Defined in#

packages/core/src/typings.ts:169


unique#

Optional unique: string | boolean

Defined in#

packages/core/src/typings.ts:194


unsigned#

Optional unsigned: boolean

Defined in#

packages/core/src/typings.ts:197


userDefined#

Optional userDefined: boolean

Defined in#

packages/core/src/typings.ts:230


version#

Optional version: boolean

Defined in#

packages/core/src/typings.ts:203


wrappedReference#

Optional wrappedReference: boolean

Defined in#

packages/core/src/typings.ts:182