Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ValidationError

There can be multiple ValidationError instances per object property.

For example suppose we have a name property decorated with the the IsAlpha annotation like this:

public class Person {
    @IsAlpha()
    @IsDefined()
    public name:string;
}

If the name property violates the IsAlpha constraint then a ValidationError instance will be created for that constraint violation. If the IsDefined constraint is violated then a separate ValidationError instance is created for that constraint.

Instances of ValidationError contain the:

  • The object and the name of the objectProperty that was validated
  • ValidationContext used to perform the validation
  • The value being validated
  • An errorIndex (When the value being validated is an array)

Hierarchy

  • ValidationError

Index

Constructors

Properties

Accessors

Constructors

constructor

Properties

Optional errorIndex

errorIndex?: Number[]

Stores the indexes of the values that failed validation when the value property is an array.

Use @fireflysemantics/is/isArray to check whether ValidationError.value is an array.

message

message: string

The error messge.

object

object: any

The object containing the invalid property.

propertyName

propertyName: string

The name of the property containing the value that did not pass the validation check.

value

value: any

The value that failed the validation check.

If this is an array of values, then the ValidationError.errorIndex stores the indices of the values that did not pass validation.

Check if the value is an array using value instanceof Array.

vc

vc: ValidationContext

The validation context

Accessors

errorMessage

  • get errorMessage(): string

  • Get the validation error message.

    Note that the implementation here is a little strange since we are passing in the vc to vc.errorMessage, which seems redundant, but we have to do it because the errorMessage function comes from the decorator and is different for each ValidationContext instance, since each is specific to a class and property context.

    Returns string

Generated using TypeDoc