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.

incrbyfloat #

Increments the number stored at key by the provided float value. If the key does not exist, it is set to 0 before performing the operation.

[Redis documentation]


incrbyfloat(key, value, [options], [callback]) #

ArgumentsTypeDescription
keystringKey identifier
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 a floating point number that contains the updated key value.

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.incrbyfloat('key', -3.14159, function (err, value) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.incrbyfloatPromise('key', -3.14159)
  .then(value => {
    // resolved once the action has completed
  });

Callback response:

38.85841