SDK
SDK Javascript v5.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.

hincrbyfloat #

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

[Redis documentation]


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

ArgumentsTypeDescription
keystringKey identifier
fieldstringHash field to increment
valuedoubleIncrement value
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return Value #

Returns the MemoryStorage object to allow chaining.


Callback Response #

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

Usage #

// 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:

48.14159