object

Inspects the low-level properties of a key.

[Redis documentation]

Arguments

Copied to clipboard!
object(key, subcommand, [options]);

Arguments Type Description
key
string
Key
subcommand
string
Object property to inspect.
Allowed values: encoding, idletime, refcount
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 inspected property value.

Usage

Copied to clipboard!
try {
  await kuzzle.ms.sadd('foo', ['bar', 'baz']);

  // Prints: hashtable
  console.log(await kuzzle.ms.object('foo', 'encoding'));
} catch (error) {
  console.error(error.message);
}