Validation

This is the official documentation of the @forestadmin/agent Node.js agent.

A field failing validation

Most data sources can import validation rules from their target. For instance, if you are using the SQL data source.

• Columns of type VARCHAR(15) will automatically carry a less than 15 chars validator.

• Non-nullable columns will automatically carry a Present validator.

However, you may want to enforce stricter restrictions than the ones which are implemented in your data source.

Adding validation rules

The list of operators (Present, LongerThan, ...) which can be used when adding validators is the same as the filter operators.

collection
  .addFieldValidation('firstName', 'Present')
  .addFieldValidation('firstName', 'LongerThan', 2)
  .addFieldValidation('firstName', 'ShorterThan', 13)
  .addFieldValidation('firstName', 'Match', /^[a-z]+$/i);

Custom validators

If you need to implement custom validators or validation over multiple fields you may use change hooks.

Make Field Optional

If the introspection marks a field as required, and you would like to make it optional, you can use the setFieldNullable function on your collection.

Be wary that if your database system does not allow empty value on the specified field, updating that field on records with an empty value will result in an error.

collection.setFieldNullable('firstName');