Main endpoint for validation Validate anything by specified schema
Promise<ValidationResult>
:
import { validate } from 'valirator';
const schema = {
FirstName: {
required: true,
},
LastName: {
required: true,
},
};
const obj = {
FirstName: 'Bob',
};
const validationResult = await validate(schema, obj);
Wrapper on validate function for sync validation Can be used if no async operation defined (rule or message)
ValidationResult
:
(any)
(any)
(any)
Promise<ValidationResult>
:
(any)
(any)
(any)
ValidationResult
:
(any)
(any)
(any)
Promise<ValidationResult>
:
(any)
(any)
(any)
ValidationResult
:
(any)
(any)
(any)
(any)
Promise<ValidationResult>
:
(any)
(any)
(any)
(any)
ValidationResult
:
(any)
(any)
(any)
(any)
(any)
(any)
Promise<ValidationResult>
:
(any)
(any)
(any)
(any)
(any)
(any)
ValidationResult
:
(any)
(any)
(any)
(any)
(any)
(any)
(any)
(any)
(any)
Promise<boolean>
:
(any)
(any)
(any)
(any)
(any)
(any)
(any)
(any)
(any)
boolean
:
Register validation rule
Override rule by name
Override rule message by name
Check if rule is registered
(string)
rule name
boolean
:
Get rule by name
(string)
{name, message, check}
:
Format message for rule
(any)
actual value
(any)
expected value
(string)
validating property
(Object)
validating object
(Function)
validating function
(Promise<string> | PromiseLike<string>)
:
(Object?= {})
validation errors
(boolean)
: check if validation result has not errors
(boolean)
: check if validation result has errors
(boolean)
: check if validation result has errors of specific types
(any)
: get validation result errors
(any)
: get first validation result errors
(Array<any>)
: get validation result errors as array
(string)
: get first validation result error
ValidationResult is util class that contain information about errors and any level
ValidationResult
:
ValidationSchema is util class that
(Object)
-
(any)
(any)
ngValidatorFn
:
(any)
(any)
ngAsyncValidatorFn
:
(any)
(any)
reduxFormValidatorFn
:
(any)
(any)
reduxFormAsyncValidatorFn
:
(any)
(any)
boolean
:
(any)
(any)
(any)
(any)
boolean
:
(any)
(any)
boolean
:
(any)
(any)
boolean
:
(any)
(any)
(any)
boolean
:
(any)
(any)
any
:
(any)
(any)
(any)
any
:
(any)
(any)
boolean
:
(any)
(any)
boolean
:
(any)
(any)
boolean
:
(any)
(any)
boolean
:
(any)
(any)
boolean
:
(any)
(any)
boolean
:
(any)
(any)
boolean
:
(any)
(any)
boolean
:
(any)
(any)
boolean
:
(any)
(any)
any
:
(any)
(any)
boolean
:
(any)
(any)
boolean
:
Empty function
Check if type
(any)
(string)
type string like: '
[
object Object
]
', '
[
object Array
]
' and etc
boolean
:
Check if is Object
(any)
boolean
:
Check if is Array
(any)
boolean
:
Check if is Function
(any)
boolean
:
Check if is String
(any)
boolean
:
Check if is Date
(any)
boolean
:
Check if is Number
(any)
boolean
:
Check if is Boolean
(any)
boolean
:
Check if is Empty Empty string -> true Empty array -> true Empty object -> true
Anything else -> false
(any)
boolean
:
Check if is Null
(any)
boolean
:
Check if is Undefined
(any)
boolean
:
Check is is Null or Undefined
(any)
boolean
:
Check is object is defined (not null, not undefined, not empty string, object or array
(any)
boolean
:
Safe convert to String
(any)
string
:
Safe indexOf
(any)
(any)
Number
:
Safe check if value in array
(any)
(any)
boolean
:
Cast item to array
(any)
Array
:
Safe check is object has property
(any)
(string)
property name
boolean
:
Safe set prototype
(any)
(any)
Object
:
Safe get prototype
(any)
any
:
Get property value
any
:
Get property override in chain
any
:
Handle Promise or PromiseLike object
((Promise | PromiseLike))
(Promise | PromiseLike)
:
Handle array of Promises or PromiseLike objects
(any)
(Promise | PromiseLike)
:
Type: Object