Write Plugins v1.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

execute #

Executes a Kuzzle's API action.

This methods does not trigger API events or request:on* events.

Arguments #

Copied to clipboard!
execute(request, [callback]);

Arguments Type Description
request Request The API query to execute
Callback to call with the API execution result

Return #

The execute function resolves to an updated Request object, with its response part set.

How the response is returned depends whether a callback argument is provided:

  • if it is: the execute function returns nothing, and the callback is called once the API call is finished, with the following arguments: callback(error, request)
  • otherwise: the execute function returns a promise, resolving to the updated request, or rejected with a KuzzleError object

Example #

Copied to clipboard!
const request = new context.constructors.Request({
  index: 'index',
  collection: 'collection',
  controller: 'document',
  action: 'get',
  _id: 'documentID'

try {
  // Mutates the provided Request object by updating the response part of
  // it (accessible through the "request.response" property).
  await context.accessors.execute(request);
} catch (error) {
  // "error" is an object inheriting the KuzzleError class