PluginContextConstructors #

The PluginContextConstructors instance is available through the PluginContext.constructors property.

It contains various classes thats allows to interact with Kuzzle.

BaseValidationType #

Abstract class that allows to define a new custom type for the Data Validation module.

ESClient #

This constructor instantiates an embedded Elasticsearch client with the same configuration as the one provided in Kuzzle configuration.

This client can be used to send raw Elasticsearch request.

See Elasticsearch official documentation for more information.

Arguments #

This class constructor takes no argument.

Usage #

const esRequest =  {
  body: {
    name: 'Aschen',
    age: 27
  },
  index: '&nyc-open-data.yellow-taxi',
  op_type: 'create'
}

// Instantiate and use a new client
const esClient = new context.constructors.ESClient()
await esClient.index(esRequest)

Koncorde #

Instantiates a new Koncorde engine.

import { Koncorde } from 'koncorde';

Repository #

Instantiates a new Repository.

Request #

Modified KuzzleRequest constructor. It can instantiate a new KuzzleRequest with the context (user, jwt, connection) of another one, or from raw data.

Arguments #

new Request(originalRequest: KuzzleRequest, requestPayload?: RequestPayload, options?: JSONObject): KuzzleRequest
new Request(requestPayload: RequestPayload, options?: JSONObject): KuzzleRequest

KuzzleRequest

RequestPayload

JSONObject

The constructor throws a plugin.context.missing_request_data error if its first argument is missing.

Usage #

const req = new context.constructors.Request(request, {
  controller: 'auth',
  action: 'getCurrentUser'
})

const user = await context.accessors.execute(req)

RequestContext #

The RequestContext class.

import { RequestContext } from 'kuzzle';

RequestInput #

The RequestInput class.

import { RequestInput } from 'kuzzle';

Mutex #

Deprecated: use withLock, exported by kuzzle, instead.

Instantiates a new mutex, allowing to lock a resource. Works both with single-node and cluster environments.

See Mutex documentation for more information.