roqueform-external-errors-plugin

The plugin that associates external errors with Roqueform fields using adapters.

npm install --save-prod roqueform roqueform-external-errors-plugin

Overview

Import and enable the plugin:

import { createField } from 'roqueform';
import errorsPlugin from 'roqueform/plugin/errors';
import externalErrorsPlugin from 'roqueform-external-errors-plugin';

const field = createField({ planet: 'Alderaan' }, [errorsPlugin(), externalErrorsPlugin()]);

Declare how fields would adapt external errors:

field.at('planet').externalErrorAdapters = [
  error => {
    if (error.code === 'fictionalPlanet') {
      return { message: 'Must be a real planet' };
    }
  },
];

Let fields adapt external errors:

const externalErrors = [{ code: 'fictionalPlanet' }];

field.setExternalErrors(externalErrors, { isRecursive: true });

field.at('planet').errors;
// ⮕ [{ message: 'Must be a real planet' }]

field.at('planet').isInvalid;
// ⮕ true