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.

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
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

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);
}

Edit this page on Github