Class ValidationErrorItem

constructor

• new ValidationErrorItem(
      message: string,
      type:
          | "CORE"
          | "DB"
          | "FUNCTION"
          | "DATATYPE"
          | "notNull violation"
          | "unique violation"
          | "Validation error",
      path?: string,
      value?: string,
      instance?: Model<any, any>,
      validatorKey?: string,
      fnName?: string,
      fnArgs?: unknown[],
  ): ValidationErrorItem

  Creates a new ValidationError item. Instances of this class are included in the ValidationError.errors property.

  Parameters

  • message: string

    An error message
  • type:
        | "CORE"
        | "DB"
        | "FUNCTION"
        | "DATATYPE"
        | "notNull violation"
        | "unique violation"
        | "Validation error"

    The type/origin of the validation error
  • Optionalpath: string

    The field that triggered the validation error
  • Optionalvalue: string

    The value that generated the error
  • Optionalinstance: Model<any, any>

    the DAO instance that caused the validation error
  • OptionalvalidatorKey: string

    a validation "key", used for identification
  • OptionalfnName: string

    property name of the BUILT-IN validator function that caused the validation error (e.g. "in" or "len"), if applicable
  • OptionalfnArgs: unknown[]

    parameters used with the BUILT-IN validator function, if applicable

  Returns ValidationErrorItem

instance

Readonlyorigin

path

Readonlytype

ReadonlyvalidatorArgs

validatorKey

validatorName

value

StaticOrigins

StaticTypeStringMap

getValidatorKey

• getValidatorKey(useTypeAsNS: false): string

  return a lowercase, trimmed string "key" that identifies the validator.

  Note: the string will be empty if the instance has neither a valid validatorKey property nor a valid validatorName property

  Parameters

  • useTypeAsNS: false

    controls whether the returned value is "namespace", this parameter is ignored if the validator's type is not one of ValidationErrorItem.Origins

  Returns string

  Throws

  thrown if NSSeparator is found to be invalid.

• getValidatorKey(useTypeAsNS?: true, NSSeparator?: string): string

  Parameters

  • OptionaluseTypeAsNS: true

    controls whether the returned value is "namespace", this parameter is ignored if the validator's type is not one of ValidationErrorItem.Origins
  • OptionalNSSeparator: string

    a separator string for concatenating the namespace, must be not be empty, defaults to "." (fullstop). only used and validated if useTypeAsNS is TRUE.

  Returns string

StaticthrowDataTypeValidationError

• throwDataTypeValidationError(message: string): never

  Parameters

  • message: string

  Returns never