Interface: FormulaOptions<T>

core.FormulaOptions

Type parameters

Name
T

Hierarchy

• PropertyOptions<T>

  ↳ FormulaOptions

Properties

columnType

• Optional columnType: string

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:42

---

comment

• Optional comment: string

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:62

---

customType

• Optional customType: Type<any, any>

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:41

---

default

• Optional default: null | string | number | boolean | string[] | number[]

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:47

---

defaultRaw

• Optional defaultRaw: string

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:48

---

fieldName

• Optional fieldName: string

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:39

---

fieldNames

• Optional fieldNames: string[]

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:40

---

formula

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

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:49

---

hidden

• Optional hidden: boolean

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:53

---

index

• Optional index: string | boolean

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:55

---

lazy

• Optional lazy: boolean

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:57

---

length

• Optional length: number

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:44

---

name

• Optional name: string

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:38

---

nullable

• Optional nullable: boolean

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:50

---

onCreate

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

Type declaration:

▸ (entity: T): any

Parameters:

Name	Type
entity	T

Returns: any

Defined in: packages/core/src/decorators/Property.ts:45

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:45

---

onUpdate

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

Type declaration:

▸ (entity: T): any

Parameters:

Name	Type
entity	T

Returns: any

Defined in: packages/core/src/decorators/Property.ts:46

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:46

---

persist

• Optional persist: boolean

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:52

---

primary

• Optional primary: boolean

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:58

---

serializedName

• Optional serializedName: string

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:61

---

serializedPrimaryKey

• Optional serializedPrimaryKey: boolean

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:59

---

serializer

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

Type declaration:

▸ (value: any): any

Parameters:

Name	Type
value	any

Returns: any

Defined in: packages/core/src/decorators/Property.ts:60

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:60

---

type

• Optional type: unknown

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:43

---

unique

• Optional unique: string | boolean

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:56

---

unsigned

• Optional unsigned: boolean

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:51

---

version

• Optional version: boolean

Inherited from: void

Defined in: packages/core/src/decorators/Property.ts:54