hincrbyfloat #
Increments the number stored in a hash field by the provided float value.
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 #
// 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
Edit this page on Github(opens new window)