Why pipes transform and validate input in NestJS - See It in Action

Why pipes transform and validate input

📖 Scenario: You are building a simple NestJS API that accepts user data. You want to make sure the data is correct and in the right format before your app uses it.

🎯 Goal: Create a NestJS pipe that transforms and validates user input. This pipe will check if the input is a number and convert it from a string to a number. If the input is not a valid number, it will throw an error.

📋 What You'll Learn

Create a pipe class named ParseIntPipe

Add a transform method that converts input to a number

Validate that the input is a number after conversion

Throw an error if the input is not a valid number

💡 Why This Matters

🌍 Real World

APIs often receive data as strings from users or other systems. Pipes help convert and check this data before your app uses it.

💼 Career

Understanding pipes is essential for building robust NestJS applications that handle input safely and correctly.

1

Create the pipe class

Create a class called ParseIntPipe that implements the PipeTransform interface from @nestjs/common.

NestJS

import { PipeTransform } from '@nestjs/common';

// Your code here

Hint

Use implements PipeTransform to create a pipe class.

2

Add transformation logic

Inside the transform method, convert the input value to a number using parseInt(value, 10) and store it in a variable called val.

NestJS

import { PipeTransform } from '@nestjs/common';

export class ParseIntPipe implements PipeTransform {
  transform(value: any) {
    // Convert value to number
    // Your code here
  }
}

Hint

Use parseInt with base 10 to convert the string to a number.

3

Add validation for number

After converting, check if val is NaN using isNaN(val). If it is, throw a BadRequestException from @nestjs/common with the message 'Validation failed: Not a number'.

NestJS

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

export class ParseIntPipe implements PipeTransform {
  transform(value: any) {
    const val = parseInt(value, 10);
    // Validate val is a number
    // Your code here
  }
}

Hint

Use BadRequestException to signal invalid input.

4

Return the transformed value

At the end of the transform method, return the variable val so the transformed number is passed on.

NestJS

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

export class ParseIntPipe implements PipeTransform {
  transform(value: any) {
    const val = parseInt(value, 10);
    if (isNaN(val)) {
      throw new BadRequestException('Validation failed: Not a number');
    }
    // Return the number
    // Your code here
  }
}

Hint

Return the transformed value so the next part of the app receives a number.

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