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.
Arguments #
incrbyfloat(key, increment, [options]);
Arguments | Type | Description |
---|---|---|
key | string | Key |
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 incremented value.
Usage #
try {
await kuzzle.ms.set('almost pi', 3);
// Prints: 3.14159
console.log(await kuzzle.ms.incrbyfloat('almost pi', 0.14159));
} catch (error) {
console.error(error.message);
}
Edit this page on Github(opens new window)