NestJS ✖️ class-validatorTips集📝

import { IsBoolean } from 'class-validator';

export class UpdateFileReq extends FileBaseReq {
  @IsBoolean()
  isUpdateFile: boolean;

  constructor(arg: {
    isUpdateFile: boolean;
    captionJa: string;
    captionEn: string;
    descriptionJa: string;
    descriptionEn: string;
    thumbnailUrl?: string;
    displayOrder: number;
  }) {
    super(arg);
    this.displayOrder = arg.displayOrder;
  }
}

import { Controller, Post, Body } from '@nestjs/common';

@Controller('file')
export class FileController {
  @Post('update')
  async updateFile(@Body() updateReq: UpdateFileReq) {
    // ここでupdateReqを使用して処理を行う
  }
}

export declare class ValidationError {
  target: object; // バリデーション対象となったオブジェクト
  property: string; // バリデーションに失敗したプロパティ名
  value: any; // バリデーションに失敗した値
  // どのバリデーションが失敗したかと、そのエラーメッセージのマッピング
  constraints?: {
    [type: string]: string;
  };
  children?: ValidationError[]; // ネストされた子プロパティのバリデーションエラーがある場合の配列
  contexts?: {
    [type: string]: any;
  };
}

import { MinLength, MaxLength } from "class-validator";

export class Post {
  @MinLength(10, {
    message: "タイトルが短すぎます（最低10文字）",
  })
  @MaxLength(50, {
    message: "タイトルが長すぎます（最大50文字）",
  })
  title: string;
}

import { MinLength, MaxLength, ValidationArguments } from "class-validator";

export class Post {
  @MinLength(10, {
    message: (args: ValidationArguments) => {
      if (args.value.length === 1) {
        return "短すぎます。最小文字数は 1 文字です。";
      } else {
        return "短すぎます。最小の長さは" + args.constraints[0] + " 文字です。";
      }
    },
  })
  title: string;
}

export interface ValidationArguments {
  value: any; // 検証される値
  constraints: any[]; // 特定の検証タイプによって定義された制約の配列
  targetName: string; // 検証されるオブジェクトのクラス名
  object: object; // 検証中のオブジェクト
  property: string; // 検証されるオブジェクトのプロパティの名前
}

import { MinLength, MaxLength } from "class-validator";

export class Post {
  @MaxLength(20, {
    each: true,
  })
  tags: string[];
}

import { ValidateNested } from "class-validator";

export class Post {
  @ValidateNested()
  user: User;
}

import { Type } from "class-transformer";
import {
  IsArray,
  IsNotEmpty,
  ValidateNested,
} from "class-validator";

class PostReq {
  @IsNotEmpty()
  title: string;

  @IsEmail()
  email: string;
}

@IsArray()
@IsNotEmpty({
    message: "空配列は、NG!",
})
@ValidateNested({ each: true })
@Type(() => PostReq)
readonly posts: PostReq[];

import { ValidateIf, IsNotEmpty } from "class-validator";

export class Post {
  isCat: string;

  // isCat の時だけ、必須となる。
  @ValidateIf((o) => o.isCat)
  @IsNotEmpty({
    message: "必須入力です。",
  })
  mya: string;
}

import { IsAscii, IsEmail, IsNotEmpty, MaxLength } from "class-validator";

export class MailCheckReq {
  @IsNotEmpty({
    message: "未入力です",
  })
  @MaxLength(256, {
    message: "{{constraint1}}文字までです",
    context: { constraint1: 256 },
  })
  @IsAscii({
    message: "不正な値です",
  })
  @IsEmail(
    {},
    {
      message: "不正な値です",
    }
  )
  email!: string;

  constructor(email: string) {
    this.email = email;
  }
}

import {
  ValidatorConstraint,
  ValidatorConstraintInterface,
} from "class-validator";

// カスタム検証クラス,
// name: isCat という名前で登録 (エラー時の ValidationError の constraints のキー名として使われます)
@ValidatorConstraint({ name: "isCat", async: false })
export class IsCatConstraint implements ValidatorConstraintInterface {
  // バリデーションのロジック
  validate(text: string) {
    return text === "cat";
  }

  // バリデーションエラー時に表示されるメッセージ
  defaultMessage(validationArguments?: ValidationArguments): string {
    return "文字列は cat でなければなりません";
  }
}

import { Validate } from "class-validator";

@Validate(IsCatConstraint)
export class CatReq {
  @IsNotEmpty()
  name: string;
}

import {
  registerDecorator,
  ValidationArguments, // validate や defaultMessage メソッドの引数として与えられるコンテキスト情報。
  ValidationOptions, // エラーメッセージや各種設定を行うためのオブジェクトを受け取る型です。
} from "class-validator";

/**
 * IsCat カスタムデコレーター
 *
 * @param validationOptions バリデーションオプション (メッセージや各種設定を指定可能)
 */
export function IsCat(validationOptions?: ValidationOptions) {
  return function (object: Object, propertyName: string) {
    registerDecorator({
      name: "isCat", // カスタムデコレーターの名前
      target: object.constructor, // デコレーターが付与されたクラス
      propertyName: propertyName, // デコレーターが付与されたプロパティ名
      options: validationOptions, // バリデーション時のオプション
      validator: {
        /**
         * バリデーションロジック
         * 値が cat と一致するかどうかをチェック
         */
        validate(value: any, args: ValidationArguments): boolean {
          return value === "cat";
        },
        /**
         * バリデーションエラー時のデフォルトメッセージ
         */
        defaultMessage(args: ValidationArguments): string {
          return "文字列は cat でなければなりません";
        },
      },
    });
  };
}

import { IsCat } from "./IsCat";

export class CatReq {
  @IsNotEmpty()
  @IsCat()
  name: string;
}