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.

Arguments #

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
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolve #

Resolves once the field has been set.

Usage #

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

Edit this page on Github