Appearance
Class: ValidationInstance<T>
Defined in: src/validator.ts:61
Individual validation instance
Type Parameters
T
T extends z.ZodTypeAny
Constructors
Constructor
new ValidationInstance<
T>(data,schema):ValidationInstance<T>
Defined in: src/validator.ts:64
Parameters
data
unknown
schema
T
Returns
ValidationInstance<T>
Methods
fails()
fails():
boolean
Defined in: src/validator.ts:76
Check if validation failed
Returns
boolean
True if validation failed
passes()
passes():
boolean
Defined in: src/validator.ts:85
Check if validation passed
Returns
boolean
True if validation passed
errors()
errors():
Record<string,string[]>
Defined in: src/validator.ts:94
Get validation errors
Returns
Record<string, string[]>
An object with field names as keys and arrays of error messages as values
firstError()
firstError(
field):string|undefined
Defined in: src/validator.ts:117
Get the first error message for a given field
Parameters
field
string
The field name
Returns
string | undefined
The first error message or undefined
validated()
validated():
output<T>
Defined in: src/validator.ts:128
Get the validated data
Returns
output<T>
The validated data
Throws
If validation failed
allErrors()
allErrors():
string[]
Defined in: src/validator.ts:140
Get all error messages as a flat array
Returns
string[]
An array of all error messages