EntityPropertyMetadata

@quik/entity

---

@quik/entity / EntityMetadata / EntityPropertyMetadata

Type Alias: EntityPropertyMetadata

EntityPropertyMetadata = object

Defined in: entity/src/metadata/entity.ts:42

Metadata for an entity property field.

Properties

afterSetter?

optional afterSetter?: QEntityFieldSetter[]

Defined in: entity/src/metadata/entity.ts:85

---

beforeSetter?

optional beforeSetter?: QEntityFieldSetter[]

Defined in: entity/src/metadata/entity.ts:84

---

ctor?

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

Defined in: entity/src/metadata/entity.ts:78

Constructor reference for complex types

---

description?

optional description?: string

Defined in: entity/src/metadata/entity.ts:50

Optional description of the field

---

flags

flags: string[]

Defined in: entity/src/metadata/entity.ts:58

Field-level flags controlling behavior

---

getter?

optional getter?: QEntityFieldGetter

Defined in: entity/src/metadata/entity.ts:74

Custom getter function for the field

---

name

name: string

Defined in: entity/src/metadata/entity.ts:46

Field name

---

others?

optional others?: Record<string, unknown>

Defined in: entity/src/metadata/entity.ts:82

Additional metadata for the field

---

sanitizers?

optional sanitizers?: QEntityFieldSetter[]

Defined in: entity/src/metadata/entity.ts:62

Value sanitizers applied when setting the field

---

setter?

optional setter?: QEntityFieldSetter

Defined in: entity/src/metadata/entity.ts:70

Custom setter function for the field

---

type

type: QFieldDataType

Defined in: entity/src/metadata/entity.ts:54

Data type of the field

---

validators?

optional validators?: QEntityFieldValidator[]

Defined in: entity/src/metadata/entity.ts:66

validators used to verify field value