SDK
SDK Javascript v7.x
2

zrem #

Removes members from a sorted set.

[Redis documentation]

Arguments #

Copied to clipboard!
zrem(key, members, [options]);

Arguments Type Description
key
string
Sorted set key
members
string[]
Member values to remove
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 number of removed members.

Usage #

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