zrangebylex

Returns elements within a provided interval, in a sorted set where all members have equal score, using lexicographical ordering.

[Redis documentation]

Arguments

Copied to clipboard!
zrangebylex(key, min, max, [options]);

Arguments Type Description
key
string
Sorted set key
min
string
Minimum range value
max
string
Maximum range value
options
object
Optional query arguments

By default, the provided min and max values are inclusive. This behavior can be changed using the syntax described in the Redis ZRANGEBYLEX documentation.

options

The options arguments can contain the following option properties:

Property Type (default) Description
limit
integer[2]
An array of 2 integers, used to limit the number of returned matching elements (similar to SELECT LIMIT offset, count in SQL).
Format: [<offset>,<count>]
queuable
boolean (true)
If true, queues the request during downtime, until connected to Kuzzle again

Resolve

Resolves to an array of matched elements.

Usage

Copied to clipboard!
try {
  await kuzzle.ms.zadd('ssetfoo', [
    {member: 'foo', score: '0'},
    {member: 'bar', score: '0'},
    {member: 'baz', score: '0'}
  ]);

  // Prints: [ 'bar', 'baz' ]
  // Lexicographically gets elements with a maximum value of 'f' (excluded),
  // without a minimum value
  console.log(await kuzzle.ms.zrangebylex('ssetfoo', '-', '(f'));
} catch (error) {
  console.error(error.message);
}