Class ValidationFailures

constructor

• new ValidationFailures(failures: ValidationFailure[]): ValidationFailures

  Creates a new instance.

  Parameters

  • failures: ValidationFailure[]

    the validation failures

  Returns ValidationFailures

  Throws

  TypeError if failures is undefined or null

Static ReadonlyEMPTY

addAll

• addAll(failures: ValidationFailures): ValidationFailures

  Adds validation failures into this collection.

  Parameters

  • failures: ValidationFailures

    the failures to add

  Returns ValidationFailures

  this

  Throws

  TypeError if failures is undefined or null

getError

• getError(): null | Error

  Returns the error for the validation failures, if any.

  1. Returns `null` if no validation has failed.
  2. Returns `MultipleFailuresError` if there were multiple failures.
  3. Returns `Throwable` if there was one failure.

  Returns null | Error

  the error or null if no validation has failed

getFailures

• getFailures(): ValidationFailure[]

  Returns the list of failed validations.

  Returns ValidationFailure[]

  an unmodifiable list of failed validations

getMessages

• getMessages(): string[]

  Returns the validation failure messages.

  Returns string[]

  an empty list if the validation was successful

isEmpty

• isEmpty(): boolean

  Checks if any validation has failed.

  Returns boolean

  false if at least one validation has failed

throwOnFailure

• throwOnFailure(): boolean

  Throws an error if a validation failed; otherwise, returns true.

  Returns boolean

  true if the validation passed

  Throws

  RangeError if a method precondition was violated

  Throws

  AssertionError if a class invariant or method postcondition was violated

  Throws

  MultipleFailuresError if more than one validation failed. This error contains a list of the failures