Class Validator

description: Creates a Validator.

Hierarchy

Validator

Index

Constructors

constructor

Methods

validate

Constructors

constructor

new Validator(objectOfRules: IValidatorRuleSet, options?: IValidatorOptions): Validator

- Defined in Validator.ts:39
description

Creates a validator schema.

Parameters
- objectOfRules: IValidatorRuleSet
  
  Set of Rule(s). key should match with the key of object being validated.
- Optional options: IValidatorOptions
  
  Options for validator schema.
Returns Validator

Methods

validate

validate(valuesToCheck: IValidatorValidateValues, options?: IValidatorValidateOptions): IValidatorValidateReturn

- Defined in Validator.ts:90
description

Validates the values passed and returns errors object if any, otherwise return undefined along with values.

Parameters
- valuesToCheck: IValidatorValidateValues
  
  Object of values to be checked.
- Optional options: IValidatorValidateOptions
  
  Options for validator.
Returns IValidatorValidateReturn

Object containing values and errors

Generated using TypeDoc