You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-03 04:01:40 +03:00
20c16e0c2c
* (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
87 lines
2.6 KiB
TypeScript
87 lines
2.6 KiB
TypeScript
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,
|
|
millisecondsSinceLastDelivery: NumberReply,
|
|
deliveriesCounter: NumberReply
|
|
]>>;
|
|
|
|
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,
|
|
group: RedisArgument,
|
|
start: RedisArgument,
|
|
end: RedisArgument,
|
|
count: number,
|
|
options?: XPendingRangeOptions
|
|
) {
|
|
parser.push('XPENDING');
|
|
parser.pushKey(key);
|
|
parser.push(group);
|
|
|
|
if (options?.IDLE !== undefined) {
|
|
parser.push('IDLE', options.IDLE.toString());
|
|
}
|
|
|
|
parser.push(start, end, count.toString());
|
|
|
|
if (options?.consumer) {
|
|
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>;
|
|
return {
|
|
id: unwrapped[0],
|
|
consumer: unwrapped[1],
|
|
millisecondsSinceLastDelivery: unwrapped[2],
|
|
deliveriesCounter: unwrapped[3]
|
|
};
|
|
});
|
|
}
|
|
} as const satisfies Command;
|