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

zrangebyscore #

Returns all sorted set elements with a score within a provided range.

The elements are considered to be ordered from low to high scores.

[Redis documentation]

Arguments #

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

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

By default, min and max are inclusive. Check the full Redis documentation for other options.

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 the list of elements in the provided score range.

Usage #

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