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

23
packages/client/lib/commands/XINFO_GROUPS.ts
View File

@@ -1,6 +1,9 @@
import { CommandParser } from '../client/parser';
import { RedisArgument, ArrayReply, TuplesToMapReply, BlobStringReply, NumberReply, NullReply, UnwrapReply, Resp2Reply, Command } from '../RESP/types';
/**
* Reply structure for XINFO GROUPS command containing information about consumer groups
*/
export type XInfoGroupsReply = ArrayReply<TuplesToMapReply<[
[BlobStringReply<'name'>, BlobStringReply],
[BlobStringReply<'consumers'>, NumberReply],
@@ -14,11 +17,31 @@ export type XInfoGroupsReply = ArrayReply<TuplesToMapReply<[
export default {
IS_READ_ONLY: true,
/**
* Constructs the XINFO GROUPS command to list the consumer groups of a stream
*
* @param parser - The command parser
* @param key - The stream key
* @returns Array of consumer group information objects
* @see https://redis.io/commands/xinfo-groups/
*/
parseCommand(parser: CommandParser, key: RedisArgument) {
parser.push('XINFO', 'GROUPS');
parser.pushKey(key);
},
transformReply: {
/**
* Transforms RESP2 reply into a structured consumer group information array
*
* @param reply - Raw RESP2 reply from Redis
* @returns Array of consumer group information objects containing:
* name - Name of the consumer group
* consumers - Number of consumers in the group
* pending - Number of pending messages for the group
* last-delivered-id - ID of the last delivered message
* entries-read - Number of entries read in the group (Redis 7.0+)
* lag - Number of entries not read by the group (Redis 7.0+)
*/
2: (reply: UnwrapReply<Resp2Reply<XInfoGroupsReply>>) => {
return reply.map(group => {
const unwrapped = group as unknown as UnwrapReply<typeof group>;