SDK
SDK Javascript v5.x
1

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.

ping #

Pings the memory storage database.

[Redis documentation]


ping([options], callback) #

ArgumentsTypeDescription
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Callback Response #

Returns a simple "PONG" string.

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.ping(function (err, response) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.pingPromise()
  .then(response => {
    // resolved once the action has completed
  });

Callback response:

"PONG"