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.

hgetall #

Returns all fields and values of a hash.

[Redis documentation]

Arguments #

Copied to clipboard!
hgetall(key, [options]);

Arguments Type Description
key
string
Hash key
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 an object representation of the hash.

Usage #

Copied to clipboard!
try {
  await kuzzle.ms.hset('hashfoo', 'field1', 'val1');
  await kuzzle.ms.hset('hashfoo', 'field2', 'val2');
  // Prints: { field1: 'val1', field2: 'val2' }
  console.log(await kuzzle.ms.hgetall('hashfoo'));
} catch (error) {
  console.error(error.message);
}