Interface ValidateModelOptions

Options to be passed to .validateModel method. Extends ValidatorOptions from class-validator with additional disable option to skip validation.

interface ValidateModelOptions {
    always?: boolean;
    disable?: boolean;
    dismissDefaultMessages?: boolean;
    enableDebugMessages?: boolean;
    forbidNonWhitelisted?: boolean;
    forbidUnknownValues?: boolean;
    groups?: string[];
    skipMissingProperties?: boolean;
    skipNullProperties?: boolean;
    skipUndefinedProperties?: boolean;
    stopAtFirstError?: boolean;
    strictGroups?: boolean;
    validationError?: { target?: boolean; value?: boolean };
    whitelist?: boolean;
}

Hierarchy

  • ValidatorOptions
    • ValidateModelOptions

Properties

always? disable? dismissDefaultMessages? enableDebugMessages? forbidNonWhitelisted? forbidUnknownValues? groups? skipMissingProperties? skipNullProperties? skipUndefinedProperties? stopAtFirstError? strictGroups? validationError? whitelist?

Properties

Optionalalways

always?: boolean

Set default for always option of decorators. Default can be overridden in decorator options.

Optionaldisable

disable?: boolean

OptionaldismissDefaultMessages

dismissDefaultMessages?: boolean

If set to true, the validation will not use default messages. Error message always will be undefined if its not explicitly set.

OptionalenableDebugMessages

enableDebugMessages?: boolean

If set to true then class-validator will print extra warning messages to the console when something is not right.

OptionalforbidNonWhitelisted

forbidNonWhitelisted?: boolean

If set to true, instead of stripping non-whitelisted properties validator will throw an error

OptionalforbidUnknownValues

forbidUnknownValues?: boolean

Fails validation for objects unknown to class-validator. Defaults to true.

For instance, since a plain empty object has no annotations used for validation:

  • validate({}) // passes
  • validate({}, { forbidUnknownValues: true }) // fails.
  • validate(new SomeAnnotatedEmptyClass(), { forbidUnknownValues: true }) // passes.

Optionalgroups

groups?: string[]

Groups to be used during validation of the object.

OptionalskipMissingProperties

skipMissingProperties?: boolean

If set to true then validator will skip validation of all properties that are null or undefined in the validating object.

OptionalskipNullProperties

skipNullProperties?: boolean

If set to true then validator will skip validation of all properties that are null in the validating object.

OptionalskipUndefinedProperties

skipUndefinedProperties?: boolean

If set to true then validator will skip validation of all properties that are undefined in the validating object.

OptionalstopAtFirstError

stopAtFirstError?: boolean

When set to true, validation of the given property will stop after encountering the first error. Defaults to false.

OptionalstrictGroups

strictGroups?: boolean

If [groups]ValidatorOptions#groups is not given or is empty, ignore decorators with at least one group.

OptionalvalidationError

validationError?: { target?: boolean; value?: boolean }

ValidationError special options.

Type declaration

  • Optionaltarget?: boolean

    Indicates if target should be exposed in ValidationError.

  • Optionalvalue?: boolean

    Indicates if validated value should be exposed in ValidationError.

Optionalwhitelist

whitelist?: boolean

If set to true validator will strip validated object of any properties that do not have any decorators.

Tip: if no other decorator is suitable for your property use

Allow

decorator.

Settings

Member Visibility

On This Page

Properties