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
69 lines
2.0 KiB
TypeScript
69 lines
2.0 KiB
TypeScript
import { CommandParser } from '../client/parser';
|
|
import { RedisArgument, ArrayReply, UnwrapReply, Command, TypeMapping } from '../RESP/types';
|
|
import { StreamMessageRawReply, transformStreamMessageReply } from './generic-transformers';
|
|
|
|
/**
|
|
* Options for the XRANGE command
|
|
*
|
|
* @property COUNT - Limit the number of entries returned
|
|
*/
|
|
export interface XRangeOptions {
|
|
COUNT?: number;
|
|
}
|
|
|
|
/**
|
|
* Helper function to build XRANGE command arguments
|
|
*
|
|
* @param start - Start of ID range (use '-' for minimum ID)
|
|
* @param end - End of ID range (use '+' for maximum ID)
|
|
* @param options - Additional options for the range query
|
|
* @returns Array of arguments for the XRANGE command
|
|
*/
|
|
export function xRangeArguments(
|
|
start: RedisArgument,
|
|
end: RedisArgument,
|
|
options?: XRangeOptions
|
|
) {
|
|
const args = [start, end];
|
|
|
|
if (options?.COUNT) {
|
|
args.push('COUNT', options.COUNT.toString());
|
|
}
|
|
|
|
return args;
|
|
}
|
|
|
|
export default {
|
|
CACHEABLE: true,
|
|
IS_READ_ONLY: true,
|
|
/**
|
|
* Constructs the XRANGE command to read stream entries in a specific range
|
|
*
|
|
* @param parser - The command parser
|
|
* @param key - The stream key
|
|
* @param args - Arguments tuple containing start ID, end ID, and options
|
|
* @returns Array of messages in the specified range
|
|
* @see https://redis.io/commands/xrange/
|
|
*/
|
|
parseCommand(parser: CommandParser, key: RedisArgument, ...args: Parameters<typeof xRangeArguments>) {
|
|
parser.push('XRANGE');
|
|
parser.pushKey(key);
|
|
parser.pushVariadic(xRangeArguments(args[0], args[1], args[2]));
|
|
},
|
|
/**
|
|
* Transforms the raw XRANGE reply into structured message objects
|
|
*
|
|
* @param reply - Raw reply from Redis
|
|
* @param preserve - Preserve options (unused)
|
|
* @param typeMapping - Type mapping for message fields
|
|
* @returns Array of structured message objects
|
|
*/
|
|
transformReply(
|
|
reply: UnwrapReply<ArrayReply<StreamMessageRawReply>>,
|
|
preserve?: any,
|
|
typeMapping?: TypeMapping
|
|
) {
|
|
return reply.map(transformStreamMessageReply.bind(undefined, typeMapping));
|
|
}
|
|
} as const satisfies Command;
|