hset

Sets a field and its value in a hash.

If the key does not exist, a new key holding a hash is created.

If the field already exists, its value is overwritten.

[Redis documentation]

Arguments

Copied to clipboard!
hset(key, field, value, [options]);

Arguments Type Description
key
string
Hash key
field
string
Field name
value
string
Field value
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 once the field has been set.

Usage

Copied to clipboard!
try {
  await kuzzle.ms.hset('hashfoo', 'foo', 'bar');

  // Prints: { foo: 'bar' }
  console.log(await kuzzle.ms.hgetall('hashfoo'));
} catch (error) {
  console.error(error.message);
}