Response transformation in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is response transformation in NestJS?

Response transformation in NestJS means changing or shaping the data before sending it back to the client. It helps to control what the client sees and keeps the response clean and consistent.

beginner

Which NestJS feature is commonly used for response transformation?

Interceptors are commonly used in NestJS to transform responses. They let you modify the data after the controller handles the request but before it is sent to the client.

intermediate

How does the map operator help in response transformation with RxJS in NestJS?

The map operator lets you change the data inside an Observable stream. In NestJS, you can use it inside interceptors to transform the response data easily and cleanly.

beginner

What is the purpose of the @UseInterceptors decorator in response transformation?

The @UseInterceptors decorator applies an interceptor to a controller or route. This lets you transform the response for that specific part of your app.

beginner

Why is response transformation important for API design?

Response transformation helps keep APIs consistent, secure, and easy to use. It hides internal details, formats data nicely, and ensures clients get only what they need.

Which NestJS feature is best for modifying response data before sending it to the client?

A Interceptor

B Pipe

C Guard

D Middleware

Interceptors are designed to transform responses, while Pipes handle input validation, Guards handle authorization, and Middleware runs before route handlers.

What RxJS operator is commonly used inside NestJS interceptors for response transformation?

A reduce

B filter

C map

D mergeMap

The map operator transforms the data inside the Observable stream, making it ideal for response transformation.

Where do you apply an interceptor to transform responses in NestJS?

A Using @UseInterceptors decorator

B Inside a service method

C In the main.ts file

D Using @Injectable decorator

The @UseInterceptors decorator is used on controllers or routes to apply interceptors.

What is a key benefit of transforming responses in an API?

A Removes all data from the response

B Slows down response time

C Makes the server code more complex

D Improves client-side data security

Transforming responses can hide sensitive data and only send what the client needs, improving security.

Which of these is NOT a typical use of response transformation?

A Formatting data output

B Validating incoming request data

C Adding extra computed fields

D Filtering sensitive fields

Validating incoming data is done by Pipes, not response transformation.

Explain how you would use an interceptor in NestJS to transform a response before sending it to the client.

Think about how you catch the response and change it before it leaves the server.

Why is response transformation useful in building APIs with NestJS? Give two reasons.

Consider what clients see and how you control that.

Practice

1. What is the main purpose of response transformation in NestJS?

easy

A. To modify data before sending it to the client

B. To handle database connections

C. To manage user authentication

D. To log server errors

Solution

1. Step 1: Understand response transformation concept

   Response transformation means changing the data before it is sent to the user.

2. Step 2: Identify the correct purpose in NestJS context

   In NestJS, response transformation is used to modify or format the response data.

3. Final Answer:

   To modify data before sending it to the client -> Option A

4. Quick Check:

   Response transformation = modify data before sending [OK]

Hint: Response transformation changes output data before sending [OK]

Common Mistakes:

• Confusing response transformation with authentication
• Thinking it manages database connections
• Assuming it logs errors

2. Which of the following is the correct way to apply a response transformation interceptor in NestJS?

easy

A. controller.transform(TransformInterceptor)

B. @UseInterceptors(new TransformInterceptor())

C. app.use(TransformInterceptor)

D. @Injectable(TransformInterceptor)

Solution

1. Step 1: Recall NestJS interceptor usage

   Interceptors are applied using the @UseInterceptors decorator on controllers or methods.

2. Step 2: Match correct syntax

   The correct syntax is @UseInterceptors(new InterceptorClass()).

3. Final Answer:

   @UseInterceptors(new TransformInterceptor()) -> Option B

4. Quick Check:

   Use @UseInterceptors with new instance [OK]

Hint: Use @UseInterceptors with new interceptor instance [OK]

Common Mistakes:

• Using @Injectable instead of @UseInterceptors
• Calling interceptor as a method on controller
• Trying to use app.use for interceptors

3. Given this interceptor code snippet, what will be the transformed response?

intercept(context, next) {
  return next.handle().pipe(map(data => ({ result: data }))); 
}

medium

A. { data: originalData }

B. originalData

C. { result: originalData }

D. An error will occur

Solution

1. Step 1: Understand the interceptor's map function

   The map operator wraps the original data inside an object with key 'result'.

2. Step 2: Predict the transformed output

   The response will be an object: { result: originalData }.

3. Final Answer:

   { result: originalData } -> Option C

4. Quick Check:

   map wraps data in { result: ... } [OK]

Hint: map operator wraps data in new object key [OK]

Common Mistakes:

• Assuming original data is unchanged
• Confusing key name as 'data' instead of 'result'
• Expecting an error from this code

4. What is wrong with this interceptor code that tries to transform the response?

intercept(context, next) {
  next.handle().pipe(map(data => data.trim()));
}

medium

A. next.handle() should not be called

B. map operator cannot be used inside intercept

C. trim() is not a valid method on data

D. Missing return statement for the observable

Solution

1. Step 1: Check interceptor return value

   Interceptors must return the observable from next.handle().pipe(...).

2. Step 2: Identify missing return

   The code calls next.handle().pipe(...) but does not return it, so the response is undefined.

3. Final Answer:

   Missing return statement for the observable -> Option D

4. Quick Check:

   Always return next.handle().pipe(...) [OK]

Hint: Always return the observable from intercept method [OK]

Common Mistakes:

• Forgetting to return the observable
• Assuming map cannot be used in intercept
• Misusing trim() on non-string data

5. You want to hide the user's password field from all API responses using response transformation. Which approach is best in NestJS?

hard

A. Create an interceptor that maps the response and deletes the password field

B. Modify the database schema to exclude password

C. Use a middleware to filter out password from requests

D. Send password as null in the controller methods

Solution

1. Step 1: Understand response transformation goal

   We want to remove sensitive info from outgoing responses, not database or requests.

2. Step 2: Choose best NestJS method

   Interceptors can transform responses globally, ideal for removing password fields before sending.

3. Step 3: Evaluate other options

   Modifying DB schema or middleware won't affect response data; setting password null in controllers is repetitive.

4. Final Answer:

   Create an interceptor that maps the response and deletes the password field -> Option A

5. Quick Check:

   Use interceptor to hide sensitive response data [OK]

Hint: Use interceptor to remove sensitive fields from responses [OK]

Common Mistakes:

• Trying to filter password in middleware (affects requests)
• Changing database schema instead of response
• Manually nulling password in every controller