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.

decrby #

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

[Redis documentation]

Arguments #

decrby(key, decrement, [options]);

ArgumentsTypeDescription
key
string
Key
decrement
integer
Decrement 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 updated key value.

Usage #

try {
  await kuzzle.ms.set('val', 12);
  // Prints: 42
  console.log(await kuzzle.ms.decrby('val', -30));
} catch (error) {
  console.error(error.message);
}