overview

Validity is an important concept in dream, since it can invalidate a record before saved, which prevents the record from being saved. To determine if a record is valid, Dream provides some useful helpers:

#isValid / #isInvalid

export default class User extends Dream {
  ...
  @Validates('contains', '@')
  public email: string
}

const user = User.new({ email: 'invalid-email' })
console.log(user.isValid) // false
console.log(user.isInvalid) // true

user.email = 'valid@email'
console.log(user.isValid) // true
console.log(user.isInvalid) // false

If a save is attempted against a record, each of its validations will be called. If any of the validations fail, an exception will raise which prevents the record from being saved. When Psychic intercepts this error, it will automatically trigger a 422 error code, delivering an errors payload describing the list of validation failures.