1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
Bobby I. 20c16e0c2c (docs) add jsdoc comments to command parsers (#2984)
* (docs) bloom: add jsdocs for all commands

* (docs) json: add jsdocs

* (docs) search: add jsdocs for all commands

* (docs) jsdocs for std commands

* (docs) jsdoc comments to time series commands
2025-06-03 14:38:07 +03:00

37 lines
1.1 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, ArrayReply, BlobStringReply, Command } from '../RESP/types';
import { ScanCommonOptions, parseScanArguments } from './SCAN';
import { transformSortedSetReply } from './generic-transformers';
export interface HScanEntry {
field: BlobStringReply;
value: BlobStringReply;
}
export default {
IS_READ_ONLY: true,
/**
* Incrementally iterates over a sorted set.
* @param parser - The Redis command parser.
* @param key - Key of the sorted set.
* @param cursor - Cursor position to start the scan from.
* @param options - Optional scan parameters (COUNT, MATCH, TYPE).
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
cursor: RedisArgument,
options?: ScanCommonOptions
) {
parser.push('ZSCAN');
parser.pushKey(key);
parseScanArguments(parser, cursor, options);
},
transformReply([cursor, rawMembers]: [BlobStringReply, ArrayReply<BlobStringReply>]) {
return {
cursor,
members: transformSortedSetReply[2](rawMembers)
};
}
} as const satisfies Command;