incrby #
Increments the number stored at key
by the provided integer value. If the key does not exist, it is set to 0 before performing the operation.
Arguments #
incrby(key, increment, [options]);
Arguments | Type | Description |
---|---|---|
key | string | Key |
increment | integer | 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 key value.
Usage #
try {
await kuzzle.ms.set('foo', 100);
// Prints: 42
console.log(await kuzzle.ms.incrby('foo', -58));
} catch (error) {
console.error(error.message);
}
Edit this page on Github(opens new window)