Interface ExternalErrorsMixin<ExternalError, Error>

The plugin that associates external errors with fields using adapters.

interface ExternalErrorsMixin<ExternalError, Error> {
    externalErrorAdapters: ExternalErrorAdapter<ExternalError, Error>[];
    setExternalErrors(
        externalErrors: undefined | null | ExternalError[],
        options?: SetExternalErrorsOptions<ExternalError, Error>,
    ): ExternalError[];
}

Type Parameters

ExternalError
The external error that can be adapted by the field.
Error
The error that is associated with the field.

Index

Properties

externalErrorAdapters

Methods

setExternalErrors

Properties

externalErrorAdapters

externalErrorAdapters: ExternalErrorAdapter<ExternalError, Error>[]

An array of adapters that associate errors with this field.

Methods

setExternalErrors

setExternalErrors(
externalErrors: undefined | null | ExternalError[],
options?: SetExternalErrorsOptions<ExternalError, Error>,
): ExternalError[]
Sets external errors to the field and its descendants.
Parameters
- externalErrors: undefined | null | ExternalError[]
  The external errors to set.
- Optionaloptions: SetExternalErrorsOptions<ExternalError, Error>
  Additional options.
Returns ExternalError[]
An array of external errors that were added to fields.