Core
Framework v2.x
2
Available since 2.8.0

Properties #

cluster #

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

Type Description
BackendCluster
BackendCluster instance

commit #

Type Description
string
Current GIT commit (if available)

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.

Type Description
BackendConfig
BackendConfig instance

See also the Configuration guide.

controller #

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

Type Description
BackendController
BackendController instance

See also the API Controllers guide.

hook #

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

Type Description
BackendHook
BackendHook instance

See also the Event System guide.

import #

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

Type Description
BackendImport
BackendImport instance

log #

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

Type Description
BackendLog
BackendLog instance

See also the Internal Logger guide.

name #

Application name.

Type Description
string
Application name

pipe #

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

Type Description
BackendPipe
BackendPipe instance

See also the Event System guide.

plugin #

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

Type Description
BackendPlugin
BackendPlugin instance

See also the Plugins guide.

sdk #

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

Type Description
EmbeddedSDK
EmbeddedSDK instance

See also the Embedded SDK guide.

storage #

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

Type Description
BackendStorage
BackendStorage instance

See also the Data Storage guide.

vault #

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

Type Description
BackendVault
BackendVault instance

See also the Secrets Vault guide.

version #

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

Type Description
string
Application version