QFieldDefinition

@quik/entity

---

@quik/entity / QFieldDefinition

Type Alias: QFieldDefinition<TChild>

QFieldDefinition<TChild> = object

Defined in: entity/src/decorators/Fields.ts:19

Definition for an entity field.

Type Parameters

TChild

TChild = unknown

Properties

ctor?

optional ctor?: Constructor | string | (() => Constructor)

Defined in: entity/src/decorators/Fields.ts:47

Constructor reference for complex types

---

default?

optional default?: any

Defined in: entity/src/decorators/Fields.ts:31

Default value for the field

---

flags?

optional flags?: string[]

Defined in: entity/src/decorators/Fields.ts:27

Field flags for additional behavior

---

getter?

optional getter?: QEntityFieldGetter

Defined in: entity/src/decorators/Fields.ts:43

Custom getter function for the field

---

others?

optional others?: Record<string, unknown>

Defined in: entity/src/decorators/Fields.ts:51

Additional metadata for the field

---

setter?

optional setter?: QEntityFieldSetter<TChild>

Defined in: entity/src/decorators/Fields.ts:39

Custom setter function for the field

---

type

type: QFieldDataType

Defined in: entity/src/decorators/Fields.ts:23

Data type of the field

---

validator?

optional validator?: QEntityFieldValidator

Defined in: entity/src/decorators/Fields.ts:35

Validator for the field