UsernameValidationError

バリデーション時に返される、単一のユーザー名バリデーションエラーを表します。

各エラーには、機械可読なcodeと、人が読んで理解できるmessageがあります。

Example

export interface UsernameValidationError {
  /**
   * 失敗したバリデーションルールの一意の識別子。
   * 
   * 例: `"username-too-short"`, `"username-invalid-characters"`
   */
  code: string;

  /**
   * エラーの人間が読みやすい説明。
   * 
   * 例: `"Username must be at least 3 characters long."`
   */
  message: string;

  /**
   * バリデーションエラーに関連するフィールド。通常は "username"、"email"、または "phone"。
   */
  field: string;
}

プロパティ

code · string

失敗したバリデーションルールを一意に識別するための識別子です。

例: "username-too-short", "username-invalid-characters"

field · string

バリデーションエラーに関連するフィールドで、通常は “username”、“email”、または “phone” です。

message · string

エラーの内容を人が読んで理解できる形で説明したものです。

例: "Username must be at least 3 characters long."