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

33
packages/client/lib/commands/XPENDING_RANGE.ts
View File

@@ -1,11 +1,25 @@
import { CommandParser } from '../client/parser';
import { RedisArgument, ArrayReply, TuplesReply, BlobStringReply, NumberReply, UnwrapReply, Command } from '../RESP/types';
/**
* Options for the XPENDING RANGE command
*
* @property IDLE - Filter by message idle time in milliseconds
* @property consumer - Filter by specific consumer name
*/
export interface XPendingRangeOptions {
IDLE?: number;
consumer?: RedisArgument;
}
/**
* Raw reply structure for XPENDING RANGE command
*
* @property id - Message ID
* @property consumer - Name of the consumer that holds the message
* @property millisecondsSinceLastDelivery - Time since last delivery attempt
* @property deliveriesCounter - Number of times this message was delivered
*/
type XPendingRangeRawReply = ArrayReply<TuplesReply<[
id: BlobStringReply,
consumer: BlobStringReply,
@@ -16,6 +30,19 @@ type XPendingRangeRawReply = ArrayReply<TuplesReply<[
export default {
CACHEABLE: true,
IS_READ_ONLY: true,
/**
* Constructs the XPENDING command with range parameters to get detailed information about pending messages
*
* @param parser - The command parser
* @param key - The stream key
* @param group - Name of the consumer group
* @param start - Start of ID range (use '-' for minimum ID)
* @param end - End of ID range (use '+' for maximum ID)
* @param count - Maximum number of messages to return
* @param options - Additional filtering options
* @returns Array of pending message details
* @see https://redis.io/commands/xpending/
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
@@ -39,6 +66,12 @@ export default {
parser.push(options.consumer);
}
},
/**
* Transforms the raw XPENDING RANGE reply into a structured array of message details
*
* @param reply - Raw reply from Redis
* @returns Array of objects containing message ID, consumer, idle time, and delivery count
*/
transformReply(reply: UnwrapReply<XPendingRangeRawReply>) {
return reply.map(pending => {
const unwrapped = pending as unknown as UnwrapReply<typeof pending>;