ValidationPipe setup in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of ValidationPipe in NestJS?

ValidationPipe automatically checks incoming data against defined rules to ensure it is valid before processing. It helps catch errors early and keeps the app safe.

beginner

How do you apply ValidationPipe globally in a NestJS application?

Use app.useGlobalPipes(new ValidationPipe()) inside the main.ts file after creating the app instance.

beginner

Which package must be installed to use ValidationPipe with decorators like @IsString()?

You need to install class-validator and class-transformer packages to use ValidationPipe with decorators.

intermediate

What does the 'whitelist' option do in ValidationPipe?

It removes any properties from the input object that are not defined in the DTO, helping to keep data clean and safe.

intermediate

How can you enable automatic transformation of input data types in ValidationPipe?

Set the 'transform' option to true in ValidationPipe. This converts input strings to the expected types defined in DTOs.

Where do you typically set up ValidationPipe globally in a NestJS app?

A Inside each controller method

B In main.ts using app.useGlobalPipes()

C In the service class constructor

D In the module imports array

Global pipes like ValidationPipe are set up in main.ts with app.useGlobalPipes() to apply validation app-wide.

Which decorator is used to mark a class property as a string for validation?

A @IsString()

B @IsBoolean()

C @IsNumber()

D @IsDate()

@IsString() marks a property to be validated as a string using class-validator.

What happens if ValidationPipe receives invalid data?

A It throws a BadRequestException

B It silently ignores the error

C It logs a warning but continues

D It converts data to default values

ValidationPipe throws a BadRequestException when validation fails, stopping the request.

What does setting 'forbidNonWhitelisted' to true do in ValidationPipe?

A Ignores validation rules

B Removes extra properties silently

C Allows extra properties without error

D Throws an error if extra properties exist

'forbidNonWhitelisted: true' causes ValidationPipe to throw an error if unknown properties are present.

Which packages are required to use ValidationPipe decorators?

A express and body-parser

B typeorm and graphql

C class-validator and class-transformer

D rxjs and reflect-metadata

class-validator and class-transformer provide decorators and transformation support for ValidationPipe.

Explain how to set up ValidationPipe globally in a NestJS app and why it is useful.

Think about where the app starts and how to apply validation everywhere.

Describe the purpose of the 'whitelist' and 'transform' options in ValidationPipe.

Consider how these options clean and convert data.

Practice

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

easy

A. To serve static files like images and CSS

B. To handle database connections automatically

C. To check and clean incoming data to ensure it is safe and correct

D. To manage user authentication and authorization

Solution

1. Step 1: Understand ValidationPipe role

   ValidationPipe is designed to validate and sanitize incoming data in NestJS, ensuring the data meets expected rules.

2. Step 2: Compare with other options

   Other options like database handling, authentication, or serving static files are unrelated to ValidationPipe's purpose.

3. Final Answer:

   To check and clean incoming data to ensure it is safe and correct -> Option C

4. Quick Check:

   ValidationPipe purpose = data validation and cleaning [OK]

Hint: ValidationPipe is all about checking incoming data [OK]

Common Mistakes:

• Confusing ValidationPipe with authentication features
• Thinking ValidationPipe manages database connections
• Assuming ValidationPipe serves static files

2. Which is the correct way to apply ValidationPipe globally in a NestJS app inside main.ts?

easy

A. app.useGlobalPipes(new ValidationPipe())

B. app.usePipes(new ValidationPipe())

C. app.setGlobalPipes(new ValidationPipe())

D. app.applyGlobalPipes(new ValidationPipe())

Solution

1. Step 1: Recall NestJS global pipe method

   The official method to set global pipes is app.useGlobalPipes().

2. Step 2: Check other options

   Methods like usePipes, setGlobalPipes, or applyGlobalPipes do not exist or are incorrect.

3. Final Answer:

   app.useGlobalPipes(new ValidationPipe()) -> Option A

4. Quick Check:

   Global pipe setup = useGlobalPipes() [OK]

Hint: Global pipes use app.useGlobalPipes() [OK]

Common Mistakes:

• Using non-existent methods like setGlobalPipes
• Confusing useGlobalPipes with usePipes
• Missing the 'new' keyword before ValidationPipe

3. Given this main.ts snippet, what will happen when a request sends extra properties not defined in the DTO?

app.useGlobalPipes(new ValidationPipe({ whitelist: true }));

medium

A. The request will fail with a validation error

B. Extra properties will be removed from the incoming data

C. Extra properties will be kept without changes

D. The app will crash due to unknown properties

Solution

1. Step 1: Understand whitelist option in ValidationPipe

   Setting whitelist: true removes any properties not defined in the DTO from the incoming data.

2. Step 2: Check behavior on extra properties

   With whitelist true, extra properties are stripped, not causing errors or crashes.

3. Final Answer:

   Extra properties will be removed from the incoming data -> Option B

4. Quick Check:

   whitelist true = remove extra props [OK]

Hint: whitelist true strips unknown properties [OK]

Common Mistakes:

• Thinking whitelist causes validation errors on extra props
• Assuming extra props are kept unchanged
• Believing app crashes on extra properties

4. What is wrong with this main.ts code snippet for setting up ValidationPipe globally?

app.useGlobalPipes(ValidationPipe({ transform: true }));

medium

A. Missing 'new' keyword before ValidationPipe

B. The 'transform' option is invalid

C. useGlobalPipes should be called inside a controller

D. ValidationPipe cannot be used globally

Solution

1. Step 1: Check ValidationPipe instantiation

   ValidationPipe is a class and must be instantiated with the new keyword.

2. Step 2: Validate other parts

   The transform option is valid, and useGlobalPipes is correctly used in main.ts.

3. Final Answer:

   Missing 'new' keyword before ValidationPipe -> Option A

4. Quick Check:

   Instantiate ValidationPipe with new [OK]

Hint: Always use 'new' with ValidationPipe class [OK]

Common Mistakes:

• Omitting 'new' keyword when creating ValidationPipe
• Thinking transform option is invalid
• Trying to set global pipes inside controllers

5. You want to automatically convert incoming JSON strings to their expected types in your DTOs. Which ValidationPipe option should you enable globally to achieve this?

hard

A. forbidNonWhitelisted: true

B. whitelist: true

C. disableErrorMessages: true

D. transform: true

Solution

1. Step 1: Understand transform option

   Setting transform: true tells ValidationPipe to convert incoming payloads to the types defined in DTO classes automatically.

2. Step 2: Check other options

   whitelist removes extra properties, forbidNonWhitelisted throws errors on extra props, and disableErrorMessages hides validation errors; none convert types.

3. Final Answer:

   transform: true -> Option D

4. Quick Check:

   transform true = auto type conversion [OK]

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

Common Mistakes:

• Confusing whitelist with type conversion
• Thinking forbidNonWhitelisted converts types
• Believing disableErrorMessages affects data types