SDK Javascript v5.x

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) #

Arguments Type Description
options JSON Object Optional parameters
callback function Callback

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Callback Response #

Returns a simple "PONG" string.

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser) (err, response) {
  // callback called once the action has completed
// Using promises (NodeJS only)
  .then(response => {
    // resolved once the action has completed

Callback response:

Copied to clipboard!