A library for runtime param validations using typescript decorators that works with `class-validator` library.
npm install typescript-class-validatorA library for runtime param validations using typescript decorators
that works with class-validator library.
Useful when you need to validate parameter data coming from untyped source(i.e http body, and etc...) or when you need to perform complex validations on the input params.
Using the param validation decorator you can declare your validation on the type annotation and leave the validation work to class-validator
bash
npm install --save typescript-class-validator
`Examples
`typescript
import { Validator, Validate } from 'typescript-class-validator';
import { IsDate, IsNotEmpty, MaxDate, IsEmail, Length } from 'class-validator';class DataDto {
@IsNotEmpty()
@IsEmail()
email: string;
@Length(10, 200)
@IsNotEmpty()
description: string;
@IsDate()
@IsNotEmpty()
@MaxDate(new Date())
birthDate: Date;
}
class TestClass {
@Validate()
methodName(@Validator() data: DataDto) {
}
@Validate()
serverControllerEndpoint(@Validator(DataDto, 'body') req: Request) {
}
}
const instance = new TestClass();
// Will throw class-validator errors on runtime
instance.methodName({
birthDate: new Date(),
description: '123',
email: 'fakemail'
});
instance.serverControllerEndpoint({
body: {
birthDate: new Date(),
description: '123',
email: 'fakemail'
}
});
`$3
In order to catch the validation errors you need to check if the errors is instanceof
ValidatorError;`typescript
import { ValidatorError } from 'typescript-class-validator';try {
// ... code
} catch (error) {
if (error instanceof ValidatorError) {
// here you have access to the validationErrors object that
// will contain array of
class-validator error objects.
console.log(error.validationErrors);
}
}
``