Documentation / @zerotal/validator / RuleBuilder
Class: RuleBuilder
Defined in: validator/src/RuleBuilder.ts:14
Constructors
Constructor
new RuleBuilder():
RuleBuilder
Returns
RuleBuilder
Methods
required()
required(
message?):StringRule
Defined in: validator/src/RuleBuilder.ts:22
A required value — shorthand for a required string, the most common entry point. Chain
the usual string constraints onto it: rule.required().min(2).max(50),
rule.required().email(), rule.required().min(8).confirmed(). For other types start
from the typed builder instead (rule.number(), rule.boolean(), …), which are also
required by default.
Parameters
message?
string
Returns
string()
string():
StringRule
Defined in: validator/src/RuleBuilder.ts:25
Returns
number()
number():
NumberRule
Defined in: validator/src/RuleBuilder.ts:28
Returns
boolean()
boolean():
BooleanRule
Defined in: validator/src/RuleBuilder.ts:31
Returns
date()
date():
DateRule
Defined in: validator/src/RuleBuilder.ts:34
Returns
file()
file():
FileRule
Defined in: validator/src/RuleBuilder.ts:38
Validates a File object from multipart/form-data.
Returns
password()
password():
PasswordRule
Defined in: validator/src/RuleBuilder.ts:42
Validates password strength — chain min/mixedCase/numbers/symbols.
Returns
email()
email(
message?):StringRule
Defined in: validator/src/RuleBuilder.ts:46
Parameters
message?
string
Returns
url()
url(
message?):StringRule
Defined in: validator/src/RuleBuilder.ts:50
Parameters
message?
string
Returns
uuid()
uuid(
message?):StringRule
Defined in: validator/src/RuleBuilder.ts:54
Parameters
message?
string
Returns
array()
array<
T>(item):ArrayRule<T>
Defined in: validator/src/RuleBuilder.ts:58
Type Parameters
T
T extends FieldRule
Parameters
item
T
Returns
ArrayRule<T>
object()
object<
S>(shape):ObjectRule<S>
Defined in: validator/src/RuleBuilder.ts:62
Type Parameters
S
S extends Schema
Parameters
shape
{ [K in string | number | symbol]: FieldRule }
Returns
ObjectRule<S>