Documentation / @zerotal/admin / index / Constraint
Class: Constraint
Defined in: admin/src/table/Constraint.ts:82
Constructors
Constructor
new Constraint(
key,kind?):Constraint
Defined in: admin/src/table/Constraint.ts:89
Parameters
key
string
kind?
ConstraintKind = "text"
Returns
Constraint
Methods
label()
label(
label):this
Defined in: admin/src/table/Constraint.ts:94
Parameters
label
string
Returns
this
column()
column(
column):this
Defined in: admin/src/table/Constraint.ts:100
Database column to compare, when it differs from the constraint key.
Parameters
column
string
Returns
this
options()
options(
options):this
Defined in: admin/src/table/Constraint.ts:106
Choices for a select constraint — {value: label} map or {value,label}[].
Parameters
options
Record<string, string> | ConstraintOption[]
Returns
this
getLabel()
getLabel():
string
Defined in: admin/src/table/Constraint.ts:113
Returns
string
getColumn()
getColumn():
string
Defined in: admin/src/table/Constraint.ts:117
Returns
string
operators()
operators():
ConstraintOperator[]
Defined in: admin/src/table/Constraint.ts:121
Returns
isUnary()
isUnary(
operator):boolean
Defined in: admin/src/table/Constraint.ts:137
Whether operator stands alone, needing no value from the user.
Parameters
operator
string
Returns
boolean
apply()
apply(
query,operator,value,conjunction):AdminQuery
Defined in: admin/src/table/Constraint.ts:148
Add this rule's predicates to query, joined by conjunction.
Every branch picks between the where* and orWhere* families rather than
emitting a bare OR, so a rule always combines with its siblings as one
unit and never splits a surrounding scope.
Parameters
query
operator
string
value
string