You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-06 02:15:48 +03:00
(docs) add jsdoc comments to command parsers (#2984)
* (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:
@@ -2,13 +2,30 @@ import { CommandParser } from '../client/parser';
|
||||
import { Command, RedisArgument } from '../RESP/types';
|
||||
import XRANGE, { xRangeArguments } from './XRANGE';
|
||||
|
||||
/**
|
||||
* Options for the XREVRANGE command
|
||||
*
|
||||
* @property COUNT - Limit the number of entries returned
|
||||
*/
|
||||
export interface XRevRangeOptions {
|
||||
COUNT?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Command for reading stream entries in reverse order
|
||||
*/
|
||||
export default {
|
||||
CACHEABLE: XRANGE.CACHEABLE,
|
||||
IS_READ_ONLY: XRANGE.IS_READ_ONLY,
|
||||
/**
|
||||
* Constructs the XREVRANGE command to read stream entries in reverse order
|
||||
*
|
||||
* @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 in reverse order
|
||||
* @see https://redis.io/commands/xrevrange/
|
||||
*/
|
||||
parseCommand(parser: CommandParser, key: RedisArgument, ...args: Parameters<typeof xRangeArguments>) {
|
||||
parser.push('XREVRANGE');
|
||||
parser.pushKey(key);
|
||||
|
Reference in New Issue
Block a user