1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
Bobby I. 20c16e0c2c (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
2025-06-03 14:38:07 +03:00

41 lines
1.0 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, NumberReply, NullReply, Command } from '../RESP/types';
export interface LPosOptions {
RANK?: number;
MAXLEN?: number;
}
export default {
CACHEABLE: true,
IS_READ_ONLY: true,
/**
* Constructs the LPOS command
*
* @param parser - The command parser
* @param key - The key of the list
* @param element - The element to search for
* @param options - Optional parameters for RANK and MAXLEN
* @see https://redis.io/commands/lpos/
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
element: RedisArgument,
options?: LPosOptions
) {
parser.push('LPOS');
parser.pushKey(key);
parser.push(element);
if (options?.RANK !== undefined) {
parser.push('RANK', options.RANK.toString());
}
if (options?.MAXLEN !== undefined) {
parser.push('MAXLEN', options.MAXLEN.toString());
}
},
transformReply: undefined as unknown as () => NumberReply | NullReply
} as const satisfies Command;