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

41 lines
1.3 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, BlobStringReply, Command } from '../RESP/types';
import { ScanCommonOptions, parseScanArguments} from './SCAN';
export default {
IS_READ_ONLY: true,
/**
* Constructs the SSCAN command to incrementally iterate over elements in a set
*
* @param parser - The command parser
* @param key - The key of the set to scan
* @param cursor - The cursor position to start scanning from
* @param options - Optional scanning parameters (COUNT and MATCH)
* @returns Iterator containing cursor position and matching members
* @see https://redis.io/commands/sscan/
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
cursor: RedisArgument,
options?: ScanCommonOptions
) {
parser.push('SSCAN');
parser.pushKey(key);
parseScanArguments(parser, cursor, options);
},
/**
* Transforms the SSCAN reply into a cursor result object
*
* @param cursor - The next cursor position
* @param members - Array of matching set members
* @returns Object containing cursor and members array
*/
transformReply([cursor, members]: [BlobStringReply, Array<BlobStringReply>]) {
return {
cursor,
members
};
}
} as const satisfies Command;