1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
node-redis/packages/client/lib/commands/LPOS_COUNT.ts
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

31 lines
962 B
TypeScript

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