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.

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);
}