Class Validator

Validator

Aggregated validation of given validation rules against the tested value.

Hierarchy

Validator

Index

Constructors

constructor

Properties

_rules

Accessors

rules

Methods

Constructors

constructor

new Validator(rules: ValidationRule[]): Validator

- Defined in index.ts:49
Parameters
- rules: ValidationRule[]
  
  Validation rules. FIFO order, i.e. the rules will be tested from top to bottom.
Returns Validator

Properties

Private Readonly _rules

_rules: ValidationRule[]

Accessors

rules

get rules(): ValidationRule[]

- Defined in index.ts:65
Get the validator rules.

Returns ValidationRule[]

Methods

errors

errors(value: unknown, firstErrorOnly?: boolean): string[]

- Defined in index.ts:120
Get all validation errors, if any. Otherwise it returns empty array.

Parameters
- value: unknown
  
  Validated value.
- firstErrorOnly: boolean = false
  
  Return only first error. Defaults to false.
Returns string[]

valid

valid(value: unknown): boolean

- Defined in index.ts:102
Validity predicate against the value.

Parameters
- value: unknown
  
  Validated value.
Returns boolean

validate

validate(value: unknown, firstErrorOnly?: boolean): ValidationResult

- Defined in index.ts:79
Validate against the value. If all rules are satisfied, the return value is true. Otherwise the return value is an error message of the failed rule.

Parameters
- value: unknown
  
  Validated value.
- firstErrorOnly: boolean = true
  
  Return only first error. Defaults to true. If set to false, it returns an array of errors, if any.
Returns ValidationResult

Generated using TypeDoc