SDK
SDK Javascript v5.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.

hkeys #

Returns all field names contained in a hash.

[Redis documentation]


hkeys(key, [options], callback) #

ArgumentsTypeDescription
keystringKey identifier
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Callback Response #

Returns an array of field names.

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.hkeys('key', function (err, fields) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.hkeysPromise('key')
  .then(fields => {
    // resolved once the action has completed
  });

Callback response:

["field1", "field2", "..."]