Hash
HSCAN
Hash
HSCAN
Scan a hash for fields.
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 hash
console.log(fields); // ["id", "username", "name"]
Arguments
key
string
requiredThe key of the hash.
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 field names.
count
number
Number of fields to return per call.
Response
The new cursor and the fields.
If the new cursor is 0 the iteration is complete.
Was this page helpful?
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 hash
console.log(fields); // ["id", "username", "name"]