Flags
@quik/entity / Flags
Variable: Flags
constFlags:object
Defined in: entity/src/decorators/Flags.ts:9
Collection of flag decorators for controlling entity field behavior.
Type Declaration
AllowEmpty()
AllowEmpty(
target,context):void
Allows empty values (empty strings, empty arrays, zero values).
Parameters
target
unknown
context
Returns
void
Array()
Array(
target,context):void
Marks a field as an array of values.
Parameters
target
unknown
context
Returns
void
Custom()
Custom(
flag): (target,context) =>void
Adds a custom flag to a field.
Parameters
flag
string
Custom flag name
Returns
(target, context) => void
File()
File(
target,context):void
Marks a field as a file reference.
Parameters
target
unknown
context
Returns
void
Getter()
Getter(
target,context):void
Creates a getter field only.
Parameters
target
unknown
context
Returns
void
Optional()
Optional(
target,context):void
Marks a field as optional (null/undefined values allowed).
Parameters
target
unknown
context
Returns
void
ReadOnly()
ReadOnly(
target,context):void
Marks a field as read-only (cannot be modified after creation).
Parameters
target
unknown
context
Returns
void
Required()
Required(
target,context):void
Marks a field as required (value must be defined).
Parameters
target
unknown
context
Returns
void
Selectable()
Selectable(
target,context):void
Marks a field as selectable in queries.
Parameters
target
unknown
context
Returns
void
Setter()
Setter(
target,context):void
Creates a setter field only.
Parameters
target
unknown
context
Returns
void
Slug()
Slug(
target,context):void
Marks a field as a URL slug (must be valid slug format).
Parameters
target
unknown
context
Returns
void
Url()
Url(
target,context):void
Marks a field as a URL (must be valid URL format).
Parameters
target
unknown
context
Returns
void
Virtual()
Virtual(
getter): (target,context) =>void
Creates a virtual field computed from other values.
Parameters
getter
Function that computes the field value
Returns
(target, context) => void