HSCAN

Scan a hash for fields.

1 min read

Arguments#

keystringrequired#

The key of the hash.

cursornumber#

The cursor, use 0 in the beginning and then use the returned cursor for subsequent calls.

optionsObject#

matchstring#

Glob-style pattern to filter by field names.

countnumber#

Number of fields to return per call.

Response#

[number, string[]]required

The new cursor and the fields array in format [field, value, field, value]. If the new cursor is 0 the iteration is complete.

HRANDFIELD HSET

await redis.hset("key", {  id: 1,  username: "chronark",  name: "andreas" });const [newCursor, fields] = await redis.hscan("key", 0);console.log(newCursor); // likely `0` since this is a very small hashconsole.log(fields); // ["id", 1, "username", "chronark", "name", "andreas"]