NestJs: Validating array of objects using class-validator

Question

I am trying to enforce a validation on each item of an array.

As per my understanding (please correct me if I am wrong), class-validator does not support direct validation of arrays. It requires us to create a wrapper class.

So, the following are the classes:

export class SequenceQuery {   
    @MinLength(10, {
        message: 'collection name is too short',
      })
    collection: string;
    identifier: string;
    count: number;
}
export class SequenceQueries{
    @ValidateNested({ each: true })
    queries:SequenceQuery[];
}

And the following is my controller:

  @Get("getSequence")
  async getSequence(@Body() query:SequenceQueries) {
    return await this.sequenceService.getNextSequenceNew(query)
  }

The following is the JSON that I am passing to the controller:

{"queries":  [
    {
        "collection": "A",
        "identifier": "abc",
        "count": 1
    },
    {
        "collection": "B",
        "identifier": "mno",
        "count": 5
    },
    {
        "collection": "C",
        "identifier": "xyz",
        "count": 25
    }
]}

But it doesn't seem to be working. It's not throwing any validation messages.

SamuraiJack · Accepted Answer · 2020-11-26 16:11:39Z

4

I got the solution to the problem.

I was supposed to change my wrapper class to :

export class SequenceQueries{
    @ValidateNested({ each: true })
    @Type(() => SequenceQuery) // added @Type
    queries:SequenceQuery[];
}

But I will leave the question open, just in case someone has an alternate solution as in not having to make a wrapper class.

answered Nov 26, 2020 at 16:11

SamuraiJack

5,62919 gold badges103 silver badges214 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

BivorAdrito Over a year ago

The type should be imported using nestjs class transformer

Jose Manuel Barrios Lacruz · Accepted Answer · 2022-08-30 21:01:55Z

There is my complete solution/implementation in Nestjs

First create my DTO Class

export class WebhookDto {
  @IsString()
  @IsEnum(WebHookType)
  type: string;

  @IsString()
  @IsUrl()
  url: string;

  @IsBoolean()
  active: boolean;
}

export class WebhookDtoArray {
  @IsArray()
  @ValidateNested({ each: true })
  @Type(() => WebhookDto)
  webhooks: WebhookDto[];
}

Place my DTO Class in my Controller definition

  @MessagePattern('set_webhooks')
  async setWebhooks(
    @Payload('body') webhookDtoArray: WebhookDtoArray,
    @Payload() data,
  ): Promise<Store> {
    return this.storeManagementService.setWebhooks(
      data.userPayload.id,
      webhookDtoArray,
    );
  }

An example in Postman of what the Body I should send

{
  "webhooks": [{
      "type": "InvoiceCreated",
      "url": "https://test.free.beeceptor.com",
      "active": true
    },
    {
      "type": "InvoiceSettled",
      "url": "https://test.free.beeceptor.com",
      "active": true
    },
    {
      "type": "InvoiceExpired",
      "url": "https://test.free.beeceptor.com",
      "active": true
    }
  ]
}

Ayoub Touba · Accepted Answer · 2020-11-26 17:36:24Z

0

class-validator does support array validation you have just to add what you already did in @ValidateNested({ each: true }), you have only to add each to the collection element:

export class SequenceQuery {   
@MinLength(10, {
    each: true,
    message: 'collection name is too short',
  })
collection: string;
identifier: string;
count: number;

}

source : Validation Array

answered Nov 26, 2020 at 17:36

Ayoub Touba

3,0773 gold badges16 silver badges31 bronze badges

Comments

Mehoff · Accepted Answer · 2025-04-24 07:43:55Z

0

From Nest.js documentation:

To validate the array, create a dedicated class which contains a property that wraps the array, or use the ParseArrayPipe.

@Post()
createBulk(
  @Body(new ParseArrayPipe({ items: CreateUserDto }))
  createUserDtos: CreateUserDto[],
) {
  return 'This action adds new users';
}

So, if you do not want to create a wrapper property - use ParseArrayPipe. Example Postman Body that can be used send with CreateUserDto proper validation:

[
    {
        "avatar": "http://href",
        "name": "Name"
    },
    {
        "avatar": "http://href2",
        "name": "Name2"
    },
]

answered Apr 24 at 7:43

Mehoff

1345 bronze badges

Collectives™ on Stack Overflow

NestJs: Validating array of objects using class-validator

4 Answers 4

1 Comment

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

1 Comment

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related