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

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.

[Redis documentation]

Arguments #

incrby(key, increment, [options]);

ArgumentsTypeDescription
key
string
Key
increment
integer
Increment value
options
object
Optional query arguments

options #

The options arguments can contain the following option properties:

PropertyType (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);
}