ZRANGE - Upstash Documentation

Arguments

keybodystringrequired

The key to get.

minbodynumber | stringrequired

The lower bound of the range.

maxbodynumber | stringrequired

The upper bound of the range.

optionsbody

withScoresbodyboolean

Whether to include the scores in the response.

revbodyboolean

Whether to reverse the order of the response.

byScorebodyboolean

Whether to use the score as the sort order.

byLexbodyboolean

Whether to use lexicographical ordering.

offsetbodynumber

The offset to start from.

countbodynumber

The number of elements to return.

Response

TMember[]

The values in the specified range.

If withScores is true, the response will have interleaved members and scores: [TMember, number, TMember, number, ...]

Example

await redis.zadd("key",     { score: 1, member: "m1" },    { score: 2, member: "m2" },)const res = await redis.zrange("key", 1, 3)console.log(res) // ["m2"]

WithScores

await redis.zadd("key",     { score: 1, member: "m1" },    { score: 2, member: "m2" },)const res = await redis.zrange("key", 1, 3, { withScores: true })console.log(res) // ["m2", 2]

ByScore

await redis.zadd("key",     { score: 1, member: "m1" },    { score: 2, member: "m2" },    { score: 3, member: "m3" },)const res = await redis.zrange("key", 1, 2, { byScore: true })console.log(res) // ["m1", "m2"]