Field » error

error() → ValidationError
error(message) → ValidationError
error(messageFunction) → ValidationError

Generate an error in the context of the element. The error includes a generic message by default, or a custom one if you supply it (which is the recommended practice). You can also pass a message function which (like the loader functions too) gets the name and value as arguments and returns a message string. This serves to create highly informative error messages that pin-point to the exact origin of the error, even when the initial reading of data is already past, e.g. when the error condition is only apparent later, when more processing has occurred or other data is available.

enocolor: cozy

javascriptconst document = eno.parse(input);
const { element, value } = document.field('color', { withElement: true });

// ...

if(value === 'cozy') {
  throw element.error('Postprocessing determined that "cozy" is not a color after all.');
}

Parameters

Highly recommended to provide one (but it's optional).Either directly pass a string, or alternatively a function returning a string.(The function is passed name and value inside a single object parameter.)

Return value

A ValidationError in the context of the element's value(and with an optional custom message).