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

@@ -1,6 +1,14 @@
import { CommandParser } from '../client/parser';
import { RedisArgument, BlobStringReply, NullReply, ArrayReply, TuplesReply, NumberReply, UnwrapReply, Command } from '../RESP/types';
/**
* Raw reply structure for XPENDING command
*
* @property pending - Number of pending messages in the group
* @property firstId - ID of the first pending message
* @property lastId - ID of the last pending message
* @property consumers - Array of consumer info with delivery counts
*/
type XPendingRawReply = TuplesReply<[
pending: NumberReply,
firstId: BlobStringReply | NullReply,
@@ -14,11 +22,26 @@ type XPendingRawReply = TuplesReply<[
export default {
CACHEABLE: true,
IS_READ_ONLY: true,
/**
* Constructs the XPENDING command to inspect pending messages of a consumer group
*
* @param parser - The command parser
* @param key - The stream key
* @param group - Name of the consumer group
* @returns Summary of pending messages including total count, ID range, and per-consumer stats
* @see https://redis.io/commands/xpending/
*/
parseCommand(parser: CommandParser, key: RedisArgument, group: RedisArgument) {
parser.push('XPENDING');
parser.pushKey(key);
parser.push(group);
},
/**
* Transforms the raw XPENDING reply into a structured object
*
* @param reply - Raw reply from Redis
* @returns Object containing pending count, ID range, and consumer statistics
*/
transformReply(reply: UnwrapReply<XPendingRawReply>) {
const consumers = reply[3] as unknown as UnwrapReply<typeof reply[3]>;
return {