如何使用 Nestjs 验证枚举值数组

Question

我觉得这个线程和这个线程的组合是我需要实现的，我很难将它们放在一起。

我有一个包含

enum

的 DTO。

使用 Postman，我发送了

PurchasableType

的

FOO

，并期望收到某种错误。看完上面的链接，感觉这个过程还是挺复杂的；这让我觉得我完全没有抓住要点。

如何使用验证管道来确保仅允许使用

purchasable-type.enum.ts

中的值？

感谢您的任何建议！

// create-order.dto.ts

import { IsEmail, IsNotEmpty, IsEnum } from 'class-validator';
import { PurchasableType } from '../enum/purchaseable-type.enum';

export class CreateOrderDto {
  @IsNotEmpty()
  readonly userId: string;

  @IsNotEmpty()
  readonly locationId: string;

  @IsNotEmpty()
  @IsEnum(PurchasableType)
  readonly purchasableType: PurchasableType;

  @IsNotEmpty()
  @IsEmail()
  readonly email: string;
}

// purchasable-type.enum.ts

export enum PurchasableType {
  CLINIC = 'CLINIC',
  EVENT = 'EVENT',
  LESSON = 'LESSON',
  RESERVATION = 'RESERVATION',
  TEAM = 'TEAM',
}

编辑

看来我也没有正确定义实体，这可能是主要问题。我仍然很好奇我的实施是好还是坏。

// order.entity.ts

...
import { PurchasableType } from '../enum/purchaseable-type.enum';

@Entity()
export class Order extends BaseEntity {
  @PrimaryGeneratedColumn()
  id: number;

@Column({
    type: 'enum',
    enum: PurchasableType,
  })

现在，当我发送

purchasableType

或

foo

时，我收到 500 错误。如果我发送任何在

enum

范围内的有效值，我将得到 200/201。

编辑2

当然 - 这是我所拥有的更广泛的观点。一切似乎都运行正常，我只是想更好地了解到底发生了什么。

// event.controller.ts

@Post('/:id/orders')
  async purchaseEventTickets(@Body() createOrderDto: CreateOrderDto): 
    Promise<Order> {
    return await this.eventService.purchaseEventTickets(createOrderDto);
  }

// create-order.dto.ts

export class CreateOrderDto {
    @IsNotEmpty()
    @IsEnum(PurchasableType)
    readonly purchasableType: PurchasableType;
}

// event.service.ts

async purchaseEventTickets(createOrderDto: CreateOrderDto): Promise<Order> {
    ...
    return await this.orderRepository.createOrder(createOrderDto);
}

// order.repository.ts

async createOrder(createOrderDto: CreateOrderDto): Promise<Order> {
    const { purchasableType } = createOrderDto;

    const order = this.create();

    order.purchasableType = purchasableType;

    try {
        await order.save();
    } catch (error) {
        this.logger.error(`Failed to create the order: ${error.stack}`);

        throw new InternalServerErrorException();
    }

    return order;
}

使用 Postman，如果我发送无效的“Foo”值作为

PurchasableType

，我会收到预期的错误。

Answer 1

我花了一段时间才找到一个好的解决方案。

@ApiProperty({
  description: 'List of enums',
  isArray: true,
  enum: MyEnum
})
@IsEnum(MyEnum, { each: true })
prop: MyEnum[];

Answer 2

这是您的

create-dto

的样子，其中包含

enum

。

// create-order.dto.ts

import { IsEmail, IsNotEmpty, IsEnum } from 'class-validator';
import { PurchasableType } from '../enum/purchaseable-type.enum';

export class CreateOrderDto {

    ...

    @IsNotEmpty()
    @IsEnum(PurchasableType)
    readonly purchasableType: PurchasableType;
}

该枚举文件如下所示：

// purchasable-type.enum.ts

export enum PurchasableType {
  CLINIC = 'CLINIC',
  EVENT = 'EVENT',
  LESSON = 'LESSON',
  RESERVATION = 'RESERVATION',
  TEAM = 'TEAM',
}

从那里我可以自信地期望枚举的值是上述值之一。如果出现其他值，nest 将抛出验证错误。

此外，如果您尝试使用嵌套对象（或具有多个属性或数组的对象），您可以在 DTO 中执行以下操作：

import { PurchasableType } from '../interface/purchasable-type.interface';
...

@ApiProperty()
@IsArray()
@ArrayMinSize(7)
@ArrayMaxSize(7)
@ValidateNested({ each: true })
@Type(() => PurchasableType)
@IsNotEmpty()
readonly PurchasableType: PurchasableType[];

...

Answer 3

  @IsArray()
  @IsEnum(enum, { each: true })
  prop: enum[]

Answer 4

  @IsEnum(myEnum, { each: true })
  @Transform((value) => myEnum[value])
  tags: myEnum[];

Answer 5

以上都不适合我，我是这样做的：

@Column({ type: 'enum', enum: MyEnum, array: true })
myProperty: MyEnum[];

Answer 6

enum PARAM_TYPE {
  VENUE_NAME = 'VENUE_NAME',
  USER_NAME = 'USER_NAME',
}

---

@ApiPropertyOptional({
isArray: true,
 enum: ENUM_TYPE
})
@IsEnum(PARAM_TYPE, { each: true })
params: PARAM_TYPE[];