Interface ValidZenValidationError

interface ValidZenValidationError {
    validationArgumentsConstraints?: any[];
    children?: Partial<ValidZenValidationError>[];
    toString?(shouldDecorate?: boolean, hasParent?: boolean, parentPath?: string, showConstraintMessages?: boolean): string;
    target?: object;
    property?: string;
    value?: any;
    constraints?: {
        [type: string]: string;
    };
    contexts?: {
        [type: string]: any;
    };
}

Hierarchy

  • Omit<Partial<ValidationError>, "children">
    • ValidZenValidationError

Methods

toString?

Properties

validationArgumentsConstraints? children? target? property? value? constraints? contexts?

Methods

OptionaltoString

  • toString(shouldDecorate?, hasParent?, parentPath?, showConstraintMessages?): string

  • Parameters

    • OptionalshouldDecorate: boolean

      decorate the message with ANSI formatter escape codes for better readability

    • OptionalhasParent: boolean

      true when the error is a child of an another one

    • OptionalparentPath: string

      path as string to the parent of this property

    • OptionalshowConstraintMessages: boolean

      show constraint messages instead of constraint names

    Returns string

Properties

OptionalvalidationArgumentsConstraints

validationArgumentsConstraints?: any[]

Optionalchildren

children?: Partial<ValidZenValidationError>[]

Optionaltarget

target?: object

Object that was validated.

OPTIONAL - configurable via the ValidatorOptions.validationError.target option

Optionalproperty

property?: string

Object's property that haven't pass validation.

Optionalvalue

value?: any

Value that haven't pass a validation.

OPTIONAL - configurable via the ValidatorOptions.validationError.value option

Optionalconstraints

constraints?: {
    [type: string]: string;
}

Constraints that failed validation with error messages.

Optionalcontexts

contexts?: {
    [type: string]: any;
}

On This Page

Methods
Properties