SDK Javascript v5.x

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.

hincrbyfloat #

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

[Redis documentation] (opens new window)

hincrbyfloat(key, field, value, [options], [callback]) #

Arguments Type Description
key string Key identifier
field string Hash field to increment
value double Increment value
options JSON Object Optional parameters
callback function Callback

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Return Value #

Returns the MemoryStorage object to allow chaining.

Callback Response #

Returns the newly incremented value, as a floating point number.

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.hincrbyfloat('key', 'field', 3.14159, function (err, value) {
  // callback called once the action has completed
// Using promises (NodeJS only)
kuzzle.memoryStorage.hincrbyfloatPromise('key', 'field', 3.14159)
  .then(value => {
    // resolved once the action has completed

Callback response:

Copied to clipboard!