schema.fielderror.md
January 18, 2023 ยท View on GitHub
Home > @datashaper/schema > FieldError
FieldError interface
Signature:
export interface FieldError
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| constraints | Constraints | Constraints for the field so parameters can be retrieved. Note that there must be an entry in the constraints object for the rule that failed. | |
| indexes? | number[] | (Optional) Optional row indexes that failed the validation (if includeIndexes was true during validation) | |
| name | string | Name of the field this error is associated with | |
| rule | ErrorCode | Rule that failed | |
| validate? | ValidationFunction | (Optional) Validation function that produced the error, useful for re-applying at runtime. |