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_CONSUMERS.ts
View File

@@ -1,6 +1,14 @@
import { CommandParser } from '../client/parser';
import { RedisArgument, ArrayReply, TuplesToMapReply, BlobStringReply, NumberReply, UnwrapReply, Resp2Reply, Command } from '../RESP/types';
/**
* Reply structure for XINFO CONSUMERS command
*
* @property name - Name of the consumer
* @property pending - Number of pending messages for this consumer
* @property idle - Idle time in milliseconds
* @property inactive - Time in milliseconds since last interaction (Redis 7.2+)
*/
export type XInfoConsumersReply = ArrayReply<TuplesToMapReply<[
[BlobStringReply<'name'>, BlobStringReply],
[BlobStringReply<'pending'>, NumberReply],
@@ -11,12 +19,27 @@ export type XInfoConsumersReply = ArrayReply<TuplesToMapReply<[
export default {
IS_READ_ONLY: true,
/**
* Constructs the XINFO CONSUMERS command to list the consumers in a consumer group
*
* @param parser - The command parser
* @param key - The stream key
* @param group - Name of the consumer group
* @returns Array of consumer information objects
* @see https://redis.io/commands/xinfo-consumers/
*/
parseCommand(parser: CommandParser, key: RedisArgument, group: RedisArgument) {
parser.push('XINFO', 'CONSUMERS');
parser.pushKey(key);
parser.push(group);
},
transformReply: {
/**
* Transforms RESP2 reply into a structured consumer information array
*
* @param reply - Raw RESP2 reply from Redis
* @returns Array of consumer information objects
*/
2: (reply: UnwrapReply<Resp2Reply<XInfoConsumersReply>>) => {
return reply.map(consumer => {
const unwrapped = consumer as unknown as UnwrapReply<typeof consumer>;