redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-06 02:15:48 +03:00
Code Activity

(docs) add jsdoc comments to command parsers (#2984)

Browse Source 
* (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
This commit is contained in:
Bobby I.
2025-06-03 14:38:07 +03:00
committed by GitHub
parent e4a1ca467f
commit 20c16e0c2c
491 changed files with 3861 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
packages/client/lib/commands/SSCAN.ts
View File

@@ -4,6 +4,16 @@ 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,
@@ -14,6 +24,13 @@ export default {
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,