hincrbyfloat

Increments the number stored in a hash field by the provided float value.

[Redis documentation]

Arguments

Copied to clipboard!
hincrbyfloat(key, field, increment, [options]);

Arguments Type Description
key
string
Hash key
field
string
Field name
increment
number
Increment 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 to the updated value of the hash's field.

Usage

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

  // Prints: 3.14159
  console.log(await kuzzle.ms.hincrbyfloat('hashfoo', 'almost_pi', 0.14159));
} catch (error) {
  console.error(error.message);
}