Fields
@quik/entity / Fields
Variable: Fields
constFields:object
Defined in: entity/src/decorators/Fields.ts:103
Collection of field decorators for defining entity properties.
Type Declaration
Array()
Array(
props?): (target,context) =>void
Array field decorator (untyped array).
Parameters
props?
Field properties
Returns
(target, context) => void
ArrayOf()
ArrayOf(
decorator): (target,context) =>void
Marks another field decorator as array-based.
Parameters
decorator
(target, context) => void
Base field decorator to wrap
Returns
(target, context) => void
Base64()
Base64(
props?): (target,context) =>void
Base64 encoded string field decorator.
Parameters
props?
Field properties
Returns
(target, context) => void
Boolean()
Boolean(
props?): (target,context) =>void
Boolean field decorator.
Parameters
props?
Field properties
Returns
(target, context) => void
Date()
Date(
props?): (target,context) =>void
Date field decorator (date only, no time).
Parameters
props?
Field properties
Returns
(target, context) => void
DateTime()
DateTime(
props?): (target,context) =>void
DateTime field decorator (date and time).
Parameters
props?
Field properties
Returns
(target, context) => void
Decimal()
Decimal(
props?): (target,context) =>void
Decimal (floating point) field decorator.
Parameters
props?
Field properties
Returns
(target, context) => void
Email()
Email(
props?): (target,context) =>void
Email field decorator with email validation and sanitization.
Parameters
props?
Field properties
Returns
(target, context) => void
Entity()
Entity(
entityOrProps,maybeOptions?): (target,context) =>void
Entity field decorator for referencing other entities.
Parameters
entityOrProps
string | Constructor<QEntity> | QEntityFieldProps<QEntity>
Entity constructor or field properties
maybeOptions?
Additional field properties if first parameter is entity constructor
Returns
(target, context) => void
Enum()
Enum<
T>(enumOptions,props?): (target,context) =>void
Enum field decorator for TypeScript enumerations.
Type Parameters
T
T extends any[] | Record<string, any>
Parameters
enumOptions
T
Enum object or array of values
props?
Field properties
Returns
(target, context) => void
Field()
Field<
TChild>(properties): (target,context) =>void
Base field decorator that all other field types extend.
Type Parameters
TChild
TChild = unknown
Parameters
properties
QFieldDefinition<TChild>
Field definition properties
Returns
(target, context) => void
Integer()
Integer(
props?): (target,context) =>void
Integer field decorator.
Parameters
props?
Field properties
Returns
(target, context) => void
Interface()
Interface(
interfaceOrProps,maybeOptions?): (target,context) =>void
Interface field decorator for TypeScript interfaces.
Parameters
interfaceOrProps
string | QObjectFieldProps<unknown>
Interface name or field properties
maybeOptions?
Additional field properties if first parameter is interface name
Returns
(target, context) => void
JWT()
JWT(
props?): (target,context) =>void
JSON Web Token field decorator.
Parameters
props?
Field properties
Returns
(target, context) => void
Map()
Map<
K,V>(props?): (target,context) =>void
Map field decorator for JavaScript Map objects.
Type Parameters
K
K = any
V
V = any
Parameters
props?
Field properties
Returns
(target, context) => void
Number()
Number(
props?): (target,context) =>void
Number field decorator.
Parameters
props?
Field properties
Returns
(target, context) => void
Object()
Object(
constructorOrProps,maybeOptions?): (target,context) =>void
Object field decorator for JavaScript objects.
Parameters
constructorOrProps
QObjectFieldProps<unknown> | Constructor<unknown> | AbstractConstructor<unknown>
Constructor or field properties
maybeOptions?
Additional field properties if first parameter is constructor
Returns
(target, context) => void
Password()
Password(
props?): (target,context) =>void
Password field decorator (automatically hidden in responses).
Parameters
props?
Field properties
Returns
(target, context) => void
Set()
Set<
T>(props?): (target,context) =>void
Set field decorator for JavaScript Set objects.
Type Parameters
T
T = any
Parameters
props?
Field properties
Returns
(target, context) => void
SetOf()
SetOf(
decorator): (target,context) =>void
Marks another field decorator as set-based (stored internally as Set).
Parameters
decorator
(target, context) => void
Base field decorator to wrap
Returns
(target, context) => void
Setter()
Setter(
setter): (target,context) =>void
Parameters
setter
Returns
(target, context) => void
String()
String(
props?): (target,context) =>void
String field decorator.
Parameters
props?
Field properties
Returns
(target, context) => void
Timestamp()
Timestamp(
props?): (target,context) =>void
Timestamp field decorator (milliseconds since epoch).
Parameters
props?
Field properties
Returns
(target, context) => void