ValidatorOptions | @nestjs/common

Options passed to validator during validation.

Index

dismissDefaultMessages: boolean

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

forbidNonWhitelisted: boolean

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

forbidUnknownValues: boolean

Setting true will cause fail validation of unknown objects.

groups: string[]

Groups to be used during validation of the object.

skipMissingProperties: boolean

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

validationError: object

ValidationError special options.

Optional target?: boolean

Indicates if target should be exposed in ValidationError.
Optional value?: boolean

Indicates if validated value should be exposed in ValidationError.

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.