SDK
SDK Javascript v6.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]

Arguments #

ping([options]);

ArgumentsTypeDescription
options
object
Optional query arguments

options #

The options arguments can contain the following option properties:

PropertyType (default)Description
queuable
boolean (true)
If true, queues the request during downtime, until connected to Kuzzle again

Resolve #

Resolves to the string PONG.

Usage #

try {
  // Prints: PONG
  console.log(await kuzzle.ms.ping());
} catch (error) {
  console.error(error.message);
}