Interface: ValidationIssue<Ref, Details>
Type parameters​
| Name | Type |
|---|---|
Ref | unknown |
Details | unknown |
Properties​
description​
• description: string
A brief description of the violation. This does not have to be appropriate for end users, who should typically be shown internationalized, customized messages.
Defined in​
details​
• Optional details: Details
Details specific to the validation performed that will be helpful to understand the violation.
Defined in​
ref​
• Optional ref: Ref
A reference to the source of the validation issue. This should be specific enough to allow dereferencing to a particular record, field, etc. For low-level primitive validations (e.g. booleans, strings, etc.), this should be the value itself.
Defined in​
validation​
• validation: string
An identifier for the validation violation.
Defined in​
validator​
• validator: string
An identifier for the validator that caused the issue.