Interface IValidator<T>

Type parameters

T: IModel

Hierarchy

IValidator

Index

Methods

Methods

validate

validate(model: T, options?: ValidateOptions): PromiseErrorModel<T>

- Defined in types.ts:92
Method to validate model schema.

Parameters
- model: T
  
  the model to be validated.
- Optional options: ValidateOptions
  
  optional yup options used upon validation.
Returns PromiseErrorModel<T>

Optional validateAt

validateAt(path: string, value: object, options?: ValidateOptions): PromiseErrorModel<Partial<T>>
validateAt(path: string, model: T): PromiseErrorModel<Partial<T>>

- Defined in types.ts:101
Validates model value at path.

Parameters
- path: string
  
  the path in the model to validate.
- value: object
  
  the value to be validated.
- Optional options: ValidateOptions
  
  optional yup options used upon validation.
Returns PromiseErrorModel<Partial<T>>
- Defined in types.ts:109
Validates using user defined model function extracts at path for result.

Parameters
- path: string
  
  the path in the model to validate.
- model: T
  
  the current model
Returns PromiseErrorModel<Partial<T>>

Generated using TypeDoc