Properties #

cluster #

This property is an instance of the BackendCluster class that allows to interact with cluster nodes.

BackendCluster

commit #

string

Contains the current GIT commit hash if the application is run from a GIT repository.

The framework will try to go 3 level upper to find a valid GIT repository.

config #

This property is an instance of the BackendConfig class that allows to read or set the configuration values.

BackendConfig

See also the Configuration guide.

controller #

This property is an instance of the BackendController class that allows to use or register API controllers.

BackendController

See also the API Controllers guide.

hook #

This property is an instance of the BackendHook class that allows to register hooks.

BackendHook

See also the Event System guide.

import #

This property is an instance of the BackendImport class that allows to import mappings and security configuration.

BackendImport

log #

This property is an instance of the BackendLog class that allows to log messages using Kuzzle's internal logger.

BackendLog

See also the Internal Logger guide.

name #

Application name.

string

nodeId #

Cluster node identifier.

string

openApi #

This property is an instance of the BackendOpenApi class that allows to modify OpenAPI definition.

JSONObject

pipe #

This property is an instance of the BackendPipe class that allows to register pipes.

BackendPipe

See also the Event System guide.

plugin #

This property is an instance of the BackendPlugin class that allows to add plugins to the application.

BackendPlugin

See also the Plugins guide.

sdk #

This property is an instance of the EmbeddedSDK class that allows to interact with the Kuzzle API.

EmbeddedSDK

See also the Embedded SDK guide.

storage #

This property is an instance of the BackendStorage class that allows to interact directly with Elasticsearch.

BackendStorage

See also the Data Storage guide.

subscription #

This property is an instance of the BackendSubscription class that allows to manage subscriptions to the realtime engine for a specific connection.

BackendSubscription

See also the Realtime Engine guide.

vault #

This property is an instance of the BackendVault class that allows to use the secrets vault.

BackendVault

See also the Secrets Vault guide.

version #

Application version. This value will be read from the package.json if available.

string