object #
Inspects the low-level properties of a key.
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 #
// 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:
"raw"
Edit this page on Github(opens new window)