typescript-param-validator

A library for runtime param validations using typescript decorators that works with `class-validator` library.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
typescript-param-validator
1221.1.05 years ago5 years agoMinified + gzip package size for typescript-param-validator in KB

Readme

Typescript runtime param validation
A 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
import { Validator, Validate } from 'typescript-param-validator';
import { IsDate, IsNotEmpty, MaxDate, IsEmail, Length } from 'class-validators';

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) {
    
  } 
}

const instance = new TestClass();

// Will throw class-validator errors on runtime
instance.methodName({
  birthDate: new Date({
    description: '123',
    email: 'fakemail'
  })
});