SDK
SDK Javascript v7.x
2

zincrby #

Increments the score of a sorted set member by the provided value.

[Redis documentation]

Arguments #

zincrby(key, member, increment, [options]);

ArgumentsTypeDescription
key
string
Sorted set key
member
string
Member value
increment
integer
Increment to apply to the member's score
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
timeout
number

(-1)
Time (in ms) during which a request will still be waited to be resolved. Set it -1 if you want to wait indefinitely
triggerEvents
boolean

(false)
If set to true, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop.
Available since Kuzzle 2.31.0

Resolve #

Resolves to the updated member's score.

Usage #

try {
  await kuzzle.ms.zadd('ssetfoo', [
    {member: 'foo', score: '42'},
    {member: 'bar', score: '4'},
    {member: 'baz', score: '-272.15'}
  ]);
  await kuzzle.ms.zincrby('ssetfoo', 'bar', 1333);
  // Prints:
  // [ { member: 'baz', score: -272.15 },
  //   { member: 'foo', score: 42 },
  //   { member: 'bar', score: 1337 } ]
  console.log(await kuzzle.ms.zrange('ssetfoo', 0, -1));
} catch (error) {
  console.error(error.message);
}