object #

Inspects the low-level properties of a key.

Arguments #

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
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolve #

Resolves to the inspected property value.

Usage #

try {
  await kuzzle.ms.sadd('foo', ['bar', 'baz']);
  // Prints: hashtable
  console.log(await kuzzle.ms.object('foo', 'encoding'));
} catch (error) {
  console.error(error.message);
}

Edit this page on Github