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

zremrangebyrank #

Removes members from a sorted set with their position in the set between start and stop (inclusive).

Positions are 0-based, meaning the first member of the set has a position of 0.

[Redis documentation]


zremrangebyrank(key, min, max, [options], [callback]) #

ArgumentsTypeDescription
keystringKey identifier
minintMinimum position index (inclusive by default)
maxintMaximum position index (inclusive by default)
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return Value #

Returns the MemoryStorage object to allow chaining.


Callback Response #

Returns an integer containing the number of removed members from the sorted set.

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle.memoryStorage.zremrangebyrank('key', 1, 2, function (err, count) {
  // callback called once the action has completed
});
// Using promises (NodeJS only)
kuzzle.memoryStorage.zremrangebyrankPromise('key', 1, 2)
  .then(count => {
    // resolved once the action has completed
  });

Callback response:

2