Javascript 7.x

ping

Pings the memory storage database.

[Redis documentation]

Arguments

Copied to clipboard!
ping([options]);

Arguments Type Description
options
object
Optional query arguments

options

The options arguments can contain the following option properties:

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

Resolve

Resolves to the string PONG.

Usage

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