Why pipes transform and validate input in NestJS

Introduction

Pipes in NestJS help check if the data coming into your app is correct and change it into the right format. This keeps your app safe and working well.

When you want to make sure user input is the right type before using it.

When you need to change input data into a format your app expects.

When you want to stop bad data from causing errors in your app.

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

When you want to keep your code clean by handling input checks in one place.

Syntax

NestJS

import { PipeTransform, Injectable, ArgumentMetadata, BadRequestException } from '@nestjs/common';

@Injectable()
export class ExamplePipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    // Validate or transform the value
    if (typeof value !== 'string') {
      throw new BadRequestException('Invalid input');
    }
    return value.toUpperCase();
  }
}

The transform method runs automatically on input data.

Throwing an exception stops the request and sends an error response.

Examples

This pipe checks if the input can be turned into a number. If not, it throws an error.

NestJS

import { PipeTransform, Injectable, ArgumentMetadata, BadRequestException } from '@nestjs/common';

@Injectable()
export class ParseIntPipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    const val = parseInt(value, 10);
    if (isNaN(val)) {
      throw new BadRequestException('Validation failed');
    }
    return val;
  }
}

This pipe removes spaces from the start and end of a string input.

NestJS

import { PipeTransform, Injectable, ArgumentMetadata } from '@nestjs/common';

@Injectable()
export class TrimPipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    if (typeof value === 'string') {
      return value.trim();
    }
    return value;
  }
}

Sample Program

This example shows a controller that uses a pipe to check if the query parameter 'id' is a number. If not, it sends an error. If yes, it returns a message with the id.

NestJS

import { Controller, Get, Query, UsePipes, PipeTransform, Injectable, BadRequestException, ArgumentMetadata } from '@nestjs/common';

@Injectable()
class ParseIntPipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    const val = parseInt(value, 10);
    if (isNaN(val)) {
      throw new BadRequestException('Validation failed: Not a number');
    }
    return val;
  }
}

@Controller('items')
export class ItemsController {
  @Get()
  @UsePipes(new ParseIntPipe())
  getItem(@Query('id') id: string) {
    return `Item id is ${id}`;
  }
}

Important Notes

Pipes run before your route handler, so they catch bad data early.

You can reuse pipes in many places to keep your code DRY (Don't Repeat Yourself).

Always provide clear error messages to help users fix their input.

Summary

Pipes check and change input data before your app uses it.

They help keep your app safe and error-free.

Use pipes to make your code cleaner and easier to maintain.

Practice

1. What is the main purpose of pipes in NestJS when handling input data?

easy

A. To style the user interface components

B. To manage database connections

C. To check and change input data before the app uses it

D. To handle HTTP responses only

Solution

1. Step 1: Understand the role of pipes in NestJS

   Pipes are designed to process input data by validating and transforming it before it reaches the application logic.

2. Step 2: Compare options with pipe functionality

   Only To check and change input data before the app uses it describes this behavior correctly; other options relate to unrelated tasks.

3. Final Answer:

   To check and change input data before the app uses it -> Option C

4. Quick Check:

   Pipes = Validate and transform input [OK]

Hint: Pipes act on input data before app logic runs [OK]

Common Mistakes:

• Confusing pipes with UI styling tools
• Thinking pipes manage database or HTTP responses only
• Ignoring pipes' role in validation

2. Which of the following is the correct way to apply a built-in validation pipe in a NestJS controller method parameter?

easy

A. @Body(ValidationPipe) inputData: CreateDto

B. @Body(new ValidationPipe()) inputData: CreateDto

C. @Body() ValidationPipe inputData: CreateDto

D. @Body() inputData: ValidationPipe

Solution

1. Step 1: Recall NestJS pipe syntax for method parameters

   To apply a pipe, you pass an instance of the pipe class inside the decorator, e.g., @Body(new ValidationPipe()).

2. Step 2: Analyze each option's syntax

   @Body(new ValidationPipe()) inputData: CreateDto correctly instantiates and passes the ValidationPipe to @Body(). The other options either pass the class without instantiation, misplace the pipe, or confuse the order.

3. Final Answer:

   @Body(new ValidationPipe()) inputData: CreateDto -> Option B

4. Quick Check:

   Use new PipeClass() inside decorator [OK]

Hint: Use new PipeClass() inside decorator for pipes [OK]

Common Mistakes:

• Instantiating pipe with new inside decorator
• Placing pipe after parameter name
• Confusing decorator and parameter order

3. Given this NestJS pipe that transforms input to a number:

import { PipeTransform, Injectable, ArgumentMetadata } from '@nestjs/common';

@Injectable()
export class ToNumberPipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    const val = Number(value);
    if (isNaN(val)) {
      throw new Error('Validation failed');
    }
    return val;
  }
}

What will be the output if the controller method receives the string '42' as input and uses this pipe?

medium

A. The number 42

B. The string '42'

C. An error is thrown

D. The value null

Solution

1. Step 1: Understand the pipe's transform method

   The pipe converts the input value to a number using Number(value). If conversion fails, it throws an error.

2. Step 2: Apply the pipe to input '42'

   Number('42') returns 42 (a number), which is valid, so no error is thrown and 42 is returned.

3. Final Answer:

   The number 42 -> Option A

4. Quick Check:

   String '42' converts to number 42 [OK]

Hint: Number('42') converts string to number without error [OK]

Common Mistakes:

• Thinking the pipe returns the original string
• Assuming an error is thrown for numeric strings
• Confusing string and number types

4. Consider this NestJS pipe code snippet:

transform(value: any) {
  const num = parseInt(value);
  if (!num) {
    throw new Error('Invalid number');
  }
  return num;
}

What is the bug in this pipe when input is '0'?

medium

A. It throws an error incorrectly because !num is true for 0

B. It returns a string instead of a number

C. It does not parse the input at all

D. It always returns NaN

Solution

1. Step 1: Analyze the condition !num with input '0'

   parseInt('0') returns 0, but !0 is true in JavaScript, so the error is thrown incorrectly.

2. Step 2: Identify the bug cause

   The check should explicitly test for NaN, not falsy values, to avoid rejecting valid 0.

3. Final Answer:

   It throws an error incorrectly because !num is true for 0 -> Option A

4. Quick Check:

   Falsy check fails for 0, use isNaN instead [OK]

Hint: Falsy check fails for 0; use isNaN() to validate numbers [OK]

Common Mistakes:

• Using !num to check invalid numbers
• Ignoring 0 as a valid number
• Not testing for NaN explicitly

5. You want to create a custom pipe in NestJS that validates an input string is a valid email and transforms it to lowercase. Which approach correctly combines validation and transformation?

hard

A. Validate email in controller, transform in pipe

B. Only transform to lowercase without validation

C. Throw error if value is lowercase already

D. In the transform method, first check email format with regex, then return value.toLowerCase()

Solution

1. Step 1: Understand pipe responsibilities

   A pipe should both validate and transform input if needed, keeping logic together.

2. Step 2: Evaluate options for combining validation and transformation

   In the transform method, first check email format with regex, then return value.toLowerCase() correctly validates email format and then transforms to lowercase inside the pipe. Transforming to lowercase only skips validation, separating validation and transformation across controller and pipe splits the logic, and throwing an error if already lowercase is illogical.

3. Final Answer:

   In the transform method, first check email format with regex, then return value.toLowerCase() -> Option D

4. Quick Check:

   Validate then transform inside pipe [OK]

Hint: Validate first, then transform input inside one pipe [OK]

Common Mistakes:

• Separating validation and transformation outside pipe
• Skipping validation step
• Throwing errors for valid inputs