Javascript 7.x

validate

Validates a document 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.


Copied to clipboard!
validate(index, collection, document, [options]);
Argument Type Description
index
string
Index name
collection
string
Collection name
document
object
Document to validate
options
object
Query options

Options

Additional query options

Options Type
(default)
Description
queuable
boolean

(true)
If true, queues the request during downtime, until connected to Kuzzle again

Resolves

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

Usage

Copied to clipboard!
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);
}