58 lines
2.4 KiB
TypeScript
58 lines
2.4 KiB
TypeScript
import { CommandParser } from '../client/parser';
|
|
import { RedisArgument, ArrayReply, TuplesReply, BlobStringReply, NumberReply, UnwrapReply } 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
|
|
]>>;
|
|
declare const _default: {
|
|
readonly CACHEABLE: true;
|
|
readonly 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/
|
|
*/
|
|
readonly parseCommand: (this: void, parser: CommandParser, key: RedisArgument, group: RedisArgument, start: RedisArgument, end: RedisArgument, count: number, options?: XPendingRangeOptions) => void;
|
|
/**
|
|
* 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
|
|
*/
|
|
readonly transformReply: (this: void, reply: UnwrapReply<XPendingRangeRawReply>) => {
|
|
id: BlobStringReply<string>;
|
|
consumer: BlobStringReply<string>;
|
|
millisecondsSinceLastDelivery: NumberReply<number>;
|
|
deliveriesCounter: NumberReply<number>;
|
|
}[];
|
|
};
|
|
export default _default;
|
|
//# sourceMappingURL=XPENDING_RANGE.d.ts.map
|