Class Validation<T>

Type parameters

T = Record<string, any>

Hierarchy

Validation

Index

Constructors

constructor

Methods

Constructors

constructor

new Validation<T>(model?: ValidationModel, options?: { defaultStatusCode?: number; isFieldNameMode?: boolean }): Validation<T>

- Defined in src/Validation.ts:221
Type parameters
- T = Record<string, any>
Parameters
- model: ValidationModel = {}
  
  validation model
- options: { defaultStatusCode?: number; isFieldNameMode?: boolean } = {}
  
  validation default options
  - Optional defaultStatusCode?: number
  - Optional isFieldNameMode?: boolean
Returns Validation<T>

Methods

getInputParams

getInputParams(): Record<string, any>

- Defined in src/Validation.ts:505
Get input params

Returns Record<string, any>
all input params

getValidatedParams

getValidatedParams(): Record<keyof T, any>

- Defined in src/Validation.ts:497
Get only validated params

Returns Record<keyof T, any>
params, that have been validated

setModel

setModel(model?: ValidationModel): void

- Defined in src/Validation.ts:238
Set validation model

Parameters
- model: ValidationModel = {}
  
  validations model ruls
Returns void

validate

validate(params: T | Record<string, any>, filters?: ValidationFilters): boolean

- Defined in src/Validation.ts:271
Validate all object

throws
ValidationError

Parameters
- params: T | Record<string, any>
  
  input object {"test": 123, "user": {"fio":"1", "phone":"2"}}
- filters: ValidationFilters = []
  
  array of keys if need
Returns boolean

Generated using TypeDoc