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.

zrank #

Returns the position of an element in a sorted set, with scores sorted in ascending order. The index returned is 0-based (the lowest score member has an index of 0).

[Redis documentation]

Arguments #

Copied to clipboard!
zrank(key, member, [options]);

Arguments Type Description
key
string
Sorted set key
member
string
Member value
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 index of the found member in the sorted set, or to null if the member is not found.

Usage #

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