Sorted Set
ZSCAN
Sorted Set
ZSCAN
Scan a sorted set
await redis.zadd("key",
{ score: 1, member: "a" },
{ score: 2, member: "ab" },
{ score: 3, member: "b" },
{ score: 4, member: "c" },
{ score: 5, member: "d" },
)
const [newCursor, members] = await redis.sscan("key", 0, { match: "a*"});
console.log(newCursor); // likely `0` since this is a very small set
console.log(members); // ["a", "ab"]
Arguments
key
string
requiredThe key of the sorted set.
cursor
number
The cursor, use 0 in the beginning and then use the returned cursor for subsequent calls.
options
Object
match
string
Glob-style pattern to filter by members.
count
number
Number of members to return per call.
Response
The new cursor and the members.
If the new cursor is 0 the iteration is complete.
await redis.zadd("key",
{ score: 1, member: "a" },
{ score: 2, member: "ab" },
{ score: 3, member: "b" },
{ score: 4, member: "c" },
{ score: 5, member: "d" },
)
const [newCursor, members] = await redis.sscan("key", 0, { match: "a*"});
console.log(newCursor); // likely `0` since this is a very small set
console.log(members); // ["a", "ab"]