Hash
HSCAN
Scan a hash for fields.
Arguments
keybodystringrequired
The key of the hash.
cursorbodynumber
The cursor, use 0 in the beginning and then use the returned cursor for subsequent calls.
optionsbodyObject
matchbodystring
Glob-style pattern to filter by field names.
countbodynumber
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.
Basic
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"]Match
await redis.hset("key", { id: 1, username: "chronark", name: "andreas",});const [newCursor, fields] = await redis.hscan("key", 0, { match: "user*" });console.log(newCursor); // likely `0` since this is a very small hashconsole.log(fields); // ["username", "chronark"]Count
await redis.hset("key", { id: 1, username: "chronark", name: "andreas",});const [newCursor, fields] = await redis.hscan("key", 0, { count: 2 });console.log(fields); // ["id", 1, "name", "andreas", "username", "chronark"]