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/LCS_IDX.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

59 lines
1.5 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, TuplesToMapReply, BlobStringReply, ArrayReply, NumberReply, UnwrapReply, Resp2Reply, Command, TuplesReply } from '../RESP/types';
import LCS from './LCS';
export interface LcsIdxOptions {
MINMATCHLEN?: number;
}
export type LcsIdxRange = TuplesReply<[
start: NumberReply,
end: NumberReply
]>;
export type LcsIdxMatches = ArrayReply<
TuplesReply<[
key1: LcsIdxRange,
key2: LcsIdxRange
]>
>;
export type LcsIdxReply = TuplesToMapReply<[
[BlobStringReply<'matches'>, LcsIdxMatches],
[BlobStringReply<'len'>, NumberReply]
]>;
export default {
IS_READ_ONLY: LCS.IS_READ_ONLY,
/**
* Constructs the LCS command with IDX option
*
* @param parser - The command parser
* @param key1 - First key containing the first string
* @param key2 - Second key containing the second string
* @param options - Additional options for the LCS IDX command
* @see https://redis.io/commands/lcs/
*/
parseCommand(
parser: CommandParser,
key1: RedisArgument,
key2: RedisArgument,
options?: LcsIdxOptions
) {
LCS.parseCommand(parser, key1, key2);
parser.push('IDX');
if (options?.MINMATCHLEN) {
parser.push('MINMATCHLEN', options.MINMATCHLEN.toString());
}
},
transformReply: {
2: (reply: UnwrapReply<Resp2Reply<LcsIdxReply>>) => ({
matches: reply[1],
len: reply[3]
}),
3: undefined as unknown as () => LcsIdxReply
}
} as const satisfies Command;