PluginContextAccessors #

The PluginContextAccessors instance is available through the PluginContext.accessors property.

It contains various instantiated classes and methods that allow to interact with Kuzzle.

cluster #

This property is an instance of the BackendCluster class, handling interactions with cluster nodes.

TypeDescription
BackendCluster
BackendCluster instance

nodeId #

Available since 2.17.0

This property is the current Kuzzle node unique identifier.

TypeDescription
string
Current Kuzzle node unique identifier

sdk #

This property is an instance of the EmbeddedSDK class.

TypeDescription
EmbeddedSDK
EmbeddedSDK instance

See also the Embedded SDK guide.

storage #

This property is an instance of the PluginStorage class that allows to interact with the Plugin Private Storage.

TypeDescription
PluginStorage
PluginStorage instance

strategies #

This property is an instance of the PluginStrategy class that allows to dynamically add and remove Authentication Strategies.

TypeDescription
PluginStrategy
PluginStrategy instance

subscription #

This property is an instance of the Subscription class that allows to add and remove realtime subscriptions from the backend.

TypeDescription
Subscription
Subscription instance

validation #

This property gives access to the Data Validation module. It is an object with two methods, bound to the DataValidation instance of Kuzzle:

MethodDescription
addTypeAdds a custom validation type
validateValidates a request against the validation specifications

Usage #

await context.accessors.validation.validate(request, false);