Class ValidationErrorItem

Validation Error Item Instances of this class are included in the ValidationError.errors property.

Hierarchy

  • ValidationErrorItem

Constructors

constructor

Properties

instance isValidationErrorItemOrigin message normalizeString origin path type validatorArgs validatorKey validatorName value Origins TypeStringMap

Methods

getValidatorKey

Constructors

constructor

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

    Parameters

    • message: string

      An error message

    • type: "notnull violation" | "string violation" | "unique violation" | "validation error" | "CORE" | "DB" | "FUNCTION"

      The type/origin of the validation error

    • path: string

      The field that triggered the validation error

    • value: string

      The value that generated the error

    • instance: Model<any, any>

      the DAO instance that caused the validation error

    • validatorKey: string

      a validation "key", used for identification

    • fnName: string

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

    • fnArgs: unknown[]

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

    Returns ValidationErrorItem

Properties

Readonly instance

instance: null | Model<any, any>

The DAO instance that caused the validation error

Private isValidationErrorItemOrigin

isValidationErrorItemOrigin: any

Readonly message

message: string

An error message

Private normalizeString

normalizeString: any

Readonly origin

origin: null | "CORE" | "DB" | "FUNCTION"

Readonly path

path: null | string

The field that triggered the validation error

Readonly type

type: null | "notnull violation" | "string violation" | "unique violation" | "validation error"

The type/origin of the validation error

Readonly validatorArgs

validatorArgs: unknown[]

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

Readonly validatorKey

validatorKey: null | string

A validation "key", used for identification

Readonly validatorName

validatorName: null | string

Property name of the BUILT-IN validator function that caused the validation error (e.g. "in" or "len"), if applicable

Readonly value

value: null | string

The value that generated the error

Static Origins

Origins: typeof ValidationErrorItemOrigin

Deprecated

Will be removed in v7

Static TypeStringMap

TypeStringMap: typeof ValidationErrorItemType

Deprecated

Will be removed in v7

Methods

getValidatorKey

  • 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

    Throws

    thrown if NSSeparator is found to be invalid.

    Parameters

    • useTypeAsNS: boolean

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

    • NSSeparator: 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

Settings

Member Visibility

Theme

Generated using TypeDoc