zremrangebyrank #
Removes members from a sorted set, with their position in the set within a provided index range.
Positions are 0-based, meaning the first member of the set has a position of 0.
Arguments #
zremrangebyrank(key, start, stop, [options]);
Arguments | Type | Description |
---|---|---|
key | string | Sorted set key |
start | integer | Starting index offset (inclusive) |
stop | integer | Ending index offset (inclusive) |
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 elements.
Usage #
try {
await kuzzle.ms.zadd('ssetfoo', [
{member: 'foo', score: '42'},
{member: 'bar', score: '4'},
{member: 'baz', score: '-272.15'}
]);
await kuzzle.ms.zremrangebyrank('ssetfoo', 1, 2);
// Prints: [ { member: 'baz', score: -272.15 } ]
console.log(await kuzzle.ms.zrange('ssetfoo', 0, -1));
} catch (error) {
console.error(error.message);
}
Edit this page on Github (opens new window)