SDK Javascript v5.x

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] (opens new window)

object(key, subcommand, [options], callback) #

Arguments Type Description
key string Key identifier
subcommand string Name of the low-level property to inspect.
Allowed values: refcount, encoding, idletime
options JSON Object Optional parameters
callback function Callback

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Callback Response #

Returns the value of the inspected property.

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.object('key', 'encoding', function (err, property) {
  // callback called once the action has completed
// Using promises (NodeJS only)
kuzzle.memoryStorage.objectPromise('key', 'encoding')
  .then(property => {
    // resolved once the action has completed

Callback response:

Copied to clipboard!