ARSCAN - Upstash Documentation

Arguments

string

required

The array key.

number | string

required

The first index of the inclusive range.

number | string

required

The last index of the inclusive range.

Object

number

Maximum number of occupied slots to return. If provided, it must be greater than zero.

Response

Index-value pairs for occupied slots. Empty slots are skipped; a missing key returns an empty list. TypeScript returns indexes as strings; Python returns integers.

Values use the SDK’s automatic deserialization. Use TData to describe stored JSON values; it defaults to string.

await redis.armset("readings", { 10: "a", 1000: "b" });
console.log(await redis.arscan("readings", 0, 1000, { limit: 2 }));
// [["10", "a"], ["1000", "b"]]

See the server command reference for protocol details.

​Arguments

​Response

Arguments

Response