Ignore any information in NestJS that is not included in the data transfer object

Question

Ignore any information in NestJS that is not included in the data transfer object

In my NestJS controller, I have defined a route for updating locality information. The structure of the controller method is as follows:

@Put('/:id')
  updateLocalityInfo(
    @Query('type') type: string,
    @Body() data: EditLocalityDto,
    @Body('parentId', ParseIntPipe) parentId: number,
    @Param('id', ParseIntPipe) id: number,
  ) {
    console.log(data);
    return this.localitiesService.updateLocalityInformation(
      type,
      data,
      id,
      parentId,
    );
  }

While working with this route, I encountered an issue related to the Dto and the parentId variable. It appears that when I call the route, the parentId value is included in the Dto-data. Upon logging the data, I observed the following output:

{ name: 'exampleName', parentId: '1' }

The EditLocalityDto class, however, only contains a property for the name:

import { ApiProperty } from '@nestjs/swagger';

export class EditLocalityDto {
  @ApiProperty()
  name: string;
}

I am seeking a solution to remove the parentId from being part of the dto-data. How can I achieve this adjustment in a general context?

typescript controller nestjs dto

Answer 1

Answer №1

Consider two different approaches for this:

Option 1

To eliminate the redundant property using TS from the DTO:

@Put('/:id')
  updateLocalityInfo(
    @Query('type') type: string,
    @Body() { parentId: _, ...data }: EditLocalityDto,
    @Body('parentId', ParseIntPipe) parentId: number,
    @Param('id', ParseIntPipe) id: number,
  ) {
    console.log(data);
    return this.localitiesService.updateLocalityInformation(
      type,
      data,
      id,
      parentId,
    );
  }

Option 2

Rather than excluding the property, consider adding it to the DTO itself and validating it there:

@Put('/:id')
  updateLocalityInfo(
    @Query('type') type: string,
    @Body() { parentId, ...data }: EditLocalityDto,
    @Param('id', ParseIntPipe) id: number,
  ) {
    console.log(data);
    return this.localitiesService.updateLocalityInformation(
      type,
      data,
      id,
      parentId,
    );
  }

///

import { ApiProperty } from '@nestjs/swagger';

export class EditLocalityDto {
  @IsInt()
  parentId: number

  @ApiProperty()
  name: string;
}

I personally prefer the latter approach

Answer 2

Consider two different approaches for this:

Option 1

To eliminate the redundant property using TS from the DTO:

@Put('/:id')
  updateLocalityInfo(
    @Query('type') type: string,
    @Body() { parentId: _, ...data }: EditLocalityDto,
    @Body('parentId', ParseIntPipe) parentId: number,
    @Param('id', ParseIntPipe) id: number,
  ) {
    console.log(data);
    return this.localitiesService.updateLocalityInformation(
      type,
      data,
      id,
      parentId,
    );
  }

Option 2

Rather than excluding the property, consider adding it to the DTO itself and validating it there:

@Put('/:id')
  updateLocalityInfo(
    @Query('type') type: string,
    @Body() { parentId, ...data }: EditLocalityDto,
    @Param('id', ParseIntPipe) id: number,
  ) {
    console.log(data);
    return this.localitiesService.updateLocalityInformation(
      type,
      data,
      id,
      parentId,
    );
  }

///

import { ApiProperty } from '@nestjs/swagger';

export class EditLocalityDto {
  @IsInt()
  parentId: number

  @ApiProperty()
  name: string;
}

I personally prefer the latter approach

Ignore any information in NestJS that is not included in the data transfer object

Answer №1

Similar questions

Tips on preventing the need for null or undefined checks in JS/Typescript singletons that have an initialization function

Typescript does not directly manipulate values. For instance, using a statement like `if(1==2)` is prohibited

The Google Chrome console is failing to display the accurate line numbers for JavaScript errors

Eliminating an element from an object containing nested arrays

Tips for extracting data from an Angular object using the *ngFor directive

Tips on identifying and handling errors without the need for type assertions in this code segment

Encountering an error in Chrome where the property 'command' is undefined

Issue with the loading of Firebase in Chrome extension's background script is inconsistent

Angular 2 does not recognize the existence of .then in type void

Issue with Formgroup in Angular Reactive Form - Validation not functioning as expected

Due to a TypeScript error stating that the type '{ Id: number; Name: string; }' cannot be utilized as an index type, I am unable to assign a value for students at this time

Guide on Reacting to an Occurrence in Angular

When the route changes, routerCanReuse and routerOnReuse are not invoked

How can I assign a specific class to certain elements within an *ngFor loop in Angular?

Vue: Simple ways to retrieve state data in MutationAction

Why am I unable to retrieve the property from the JSON file?

Learn the technique for dynamically modifying Angular components within the main root component during runtime

The Angular Material Table is reporting an error: the data source provided does not conform to an array, Observable, or DataSource

Connecting Multiple Relationships with Many-To-Many Matches

What methods are available to expedite webpack compilation (or decouple it from server restart)?