Interface IrValidator

Represents a validation rule to be applied to a DTO property. Maps to class-validator decorators in the generated code.

interface IrValidator {
    params?: string | number;
    type:
        | "IS_EMAIL"
        | "IS_UUID"
        | "IS_DATE"
        | "IS_URL"
        | "MIN"
        | "MAX"
        | "MIN_LENGTH"
        | "MAX_LENGTH"
        | "IS_NOT_EMPTY"
        | "MATCHES";
}

Index

Properties

params? type

Properties

`Optional`params

params?: string | number

Optional parameters for validators that require configuration.

For MIN/MAX: numeric value
For MIN_LENGTH/MAX_LENGTH: numeric value
For MATCHES: regex pattern string

Example

For MIN: { params: 0 }

Example

For MATCHES: { params: '^[a-zA-Z]+$' }

type

The type of validation rule. Each type maps to a specific class-validator decorator:

IS_EMAIL → @IsEmail()
IS_UUID → @IsUUID()
IS_DATE → @IsDate()
IS_URL → @IsUrl()
MIN → @Min(value)
MAX → @Max(value)
MIN_LENGTH → @MinLength(value)
MAX_LENGTH → @MaxLength(value)
IS_NOT_EMPTY → @IsNotEmpty()
MATCHES → @Matches(pattern)

Interface IrValidator

Index

Properties

Properties

`Optional`params

Example

Example

type

Settings

On This Page

Interface IrValidator

Index

Properties

Properties

Optionalparams

Example

Example

type

Settings

On This Page

`Optional`params