validate #

Validates data against existing validation rules.

Note that if no validation specifications are set for the <index>/<collection>, the document will always be valid.

This request does not store or publish the document.

validate(index, collection, document, [options]);

string

string

object

object

Options #

Additional query options

boolean

Resolves #

Resolves to a boolean value set to true if the document is valid and false otherwise.

Usage #

try {
  const valid = await kuzzle.document.validate(
    'nyc-open-data',
    'yellow-taxi',
    { capacity: 4 }
  );
  if (valid) {
    console.log('Success');
  }
} catch (error) {
  console.error(error.message);
}