ValidationPipe in depth in NestJS

Introduction

ValidationPipe helps check if the data sent to your NestJS app is correct and safe before using it.

When you want to make sure user input follows certain rules, like required fields or correct types.

When you want to automatically transform input data into the right format or class.

When you want to stop bad or incomplete data from reaching your app logic.

When you want to send clear error messages if input data is wrong.

When you want to keep your app secure by validating all incoming requests.

Syntax

NestJS

new ValidationPipe(options?)

You create a ValidationPipe instance and pass optional settings to customize validation.

Common options include whitelist, forbidNonWhitelisted, transform, and exceptionFactory.

Examples

Basic use: applies validation globally with default settings.

NestJS

app.useGlobalPipes(new ValidationPipe());

Removes properties not in DTO and throws error if extra properties are sent.

NestJS

new ValidationPipe({ whitelist: true, forbidNonWhitelisted: true });

Automatically converts input data types to match DTO types.

NestJS

new ValidationPipe({ transform: true });

Customizes the error message returned when validation fails.

NestJS

new ValidationPipe({ exceptionFactory: (errors) => new BadRequestException('Custom error') });

Sample Program

This example shows a controller with a POST route to create a user.

The CreateUserDto class defines rules: name must be a string, age must be an integer between 1 and 120.

The ValidationPipe is used to check the input and convert types automatically.

If input is valid, it returns a message with the user's name and age.

NestJS

import { Controller, Post, Body, UsePipes, ValidationPipe, BadRequestException } from '@nestjs/common';
import { IsString, IsInt, Min, Max } from 'class-validator';

class CreateUserDto {
  @IsString()
  name: string;

  @IsInt()
  @Min(1)
  @Max(120)
  age: number;
}

@Controller('users')
export class UsersController {
  @Post()
  @UsePipes(new ValidationPipe({ whitelist: true, transform: true }))
  createUser(@Body() createUserDto: CreateUserDto) {
    return `User ${createUserDto.name} is ${createUserDto.age} years old.`;
  }
}

Important Notes

Always use DTO classes with validation decorators for best results.

Enable whitelist to remove unwanted properties automatically.

Use transform to convert strings to numbers or other types as needed.

Summary

ValidationPipe checks and cleans incoming data before your app uses it.

It helps keep your app safe and your data correct.

You can customize how it works with options like whitelist and transform.

Practice

1. What is the main purpose of ValidationPipe in a NestJS application?

easy

A. To check and clean incoming data before it is used

B. To handle database connections automatically

C. To manage user authentication and sessions

D. To serve static files like images and CSS

Solution

1. Step 1: Understand ValidationPipe role

   ValidationPipe is designed to validate and sanitize incoming request data to ensure it meets expected rules.

2. Step 2: Compare with other options

   Options B, C, and D relate to other parts of NestJS or web apps, not data validation.

3. Final Answer:

   To check and clean incoming data before it is used -> Option A

4. Quick Check:

   ValidationPipe purpose = data validation [OK]

Hint: ValidationPipe = data check and clean before use [OK]

Common Mistakes:

• Confusing ValidationPipe with authentication or database handling
• Thinking ValidationPipe serves static files
• Assuming ValidationPipe manages sessions

2. Which of the following is the correct way to enable automatic transformation of input data types using ValidationPipe in NestJS?

easy

A. new ValidationPipe({ forbidNonWhitelisted: true })

B. new ValidationPipe({ whitelist: true })

C. new ValidationPipe({ transform: true })

D. new ValidationPipe({ skipMissingProperties: true })

Solution

1. Step 1: Identify transform option

   The transform: true option enables automatic conversion of input data types to expected types.

2. Step 2: Understand other options

   whitelist removes unwanted properties, forbidNonWhitelisted throws error on extra props, skipMissingProperties skips validation for missing props.

3. Final Answer:

   new ValidationPipe({ transform: true }) -> Option C

4. Quick Check:

   transform option enables type conversion [OK]

Hint: Use transform: true to convert input types automatically [OK]

Common Mistakes:

• Confusing whitelist with transform
• Using forbidNonWhitelisted to transform data
• Thinking skipMissingProperties enables transformation

3. Given this DTO and ValidationPipe setup, what will be the output when sending { "age": "25" } in the request body?

class UserDto {
  @IsInt()
  age: number;
}

// In controller
@Post()
create(@Body(new ValidationPipe({ transform: true })) user: UserDto) {
  return typeof user.age;
}

medium

A. "string"

B. "undefined"

C. Validation error thrown

D. "number"

Solution

1. Step 1: Check ValidationPipe transform option

   Transform is true, so input string "25" will be converted to number 25.

2. Step 2: Determine returned type

   Since age is transformed to number, typeof user.age returns "number".

3. Final Answer:

   "number" -> Option D

4. Quick Check:

   transform converts string to number, so typeof = "number" [OK]

Hint: transform: true converts strings to numbers automatically [OK]

Common Mistakes:

• Assuming input stays string without transform
• Expecting validation error for string number
• Thinking age is undefined without explicit conversion

4. Identify the error in this ValidationPipe usage that causes unexpected behavior:

@Post()
create(@Body(new ValidationPipe({ whitelist: true })) user: UserDto) {
  return user;
}

// UserDto has properties: name (string), age (number)

Request body: { "name": "Alice", "age": 30, "extra": "value" }

medium

A. The ValidationPipe should have forbidNonWhitelisted to throw error on extra props

B. The whitelist option removes the extra property silently

C. The ValidationPipe is missing transform: true to convert types

D. The extra property causes a validation error

Solution

1. Step 1: Understand whitelist behavior

   Whitelist removes properties not in DTO silently without error.

2. Step 2: Check how to throw error on extra props

   To throw error on extra properties, forbidNonWhitelisted: true must be set.

3. Final Answer:

   The ValidationPipe should have forbidNonWhitelisted to throw error on extra props -> Option A

4. Quick Check:

   forbidNonWhitelisted throws error on extra props [OK]

Hint: Use forbidNonWhitelisted to reject extra properties with error [OK]

Common Mistakes:

• Thinking whitelist throws error by default
• Ignoring need for forbidNonWhitelisted option
• Confusing whitelist with transform option

5. You want to ensure that your NestJS API only accepts properties defined in your DTO, automatically converts input types, and throws an error if extra properties are sent. Which ValidationPipe configuration achieves this?

hard

A. new ValidationPipe({ whitelist: true, transform: true })

B. new ValidationPipe({ whitelist: true, transform: true, forbidNonWhitelisted: true })

C. new ValidationPipe({ transform: true, skipMissingProperties: true })

D. new ValidationPipe({ whitelist: true, forbidNonWhitelisted: true })

Solution

1. Step 1: Identify needed options

   Whitelist removes extra props, transform converts types, forbidNonWhitelisted throws error on extra props.

2. Step 2: Match options to requirements

   Only new ValidationPipe({ whitelist: true, transform: true, forbidNonWhitelisted: true }) includes all three: whitelist, transform, and forbidNonWhitelisted.

3. Final Answer:

   new ValidationPipe({ whitelist: true, transform: true, forbidNonWhitelisted: true }) -> Option B

4. Quick Check:

   Whitelist + transform + forbidNonWhitelisted = strict validation [OK]

Hint: Combine whitelist, transform, forbidNonWhitelisted for strict validation [OK]

Common Mistakes:

• Omitting forbidNonWhitelisted to throw errors
• Forgetting transform for type conversion
• Using skipMissingProperties instead of forbidNonWhitelisted