1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-06 02:15:48 +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

33 lines
1.4 KiB
TypeScript

import { CommandParser } from '@redis/client/dist/lib/client/parser';
import { RedisArgument, TuplesToMapReply, NumberReply, DoubleReply, UnwrapReply, Resp2Reply, Command, SimpleStringReply, TypeMapping } from '@redis/client/dist/lib/RESP/types';
import { transformDoubleReply } from '@redis/client/dist/lib/commands/generic-transformers';
import { transformInfoV2Reply } from '../bloom';
export type TopKInfoReplyMap = TuplesToMapReply<[
[SimpleStringReply<'k'>, NumberReply],
[SimpleStringReply<'width'>, NumberReply],
[SimpleStringReply<'depth'>, NumberReply],
[SimpleStringReply<'decay'>, DoubleReply]
]>;
export default {
IS_READ_ONLY: true,
/**
* Returns configuration and statistics of a Top-K filter, including k, width, depth, and decay parameters
* @param parser - The command parser
* @param key - The name of the Top-K filter to get information about
*/
parseCommand(parser: CommandParser, key: RedisArgument) {
parser.push('TOPK.INFO');
parser.pushKey(key);
},
transformReply: {
2: (reply: UnwrapReply<Resp2Reply<TopKInfoReplyMap>>, preserve?: any, typeMapping?: TypeMapping): TopKInfoReplyMap => {
reply[7] = transformDoubleReply[2](reply[7], preserve, typeMapping) as any;
return transformInfoV2Reply<TopKInfoReplyMap>(reply, typeMapping);
},
3: undefined as unknown as () => TopKInfoReplyMap
}
} as const satisfies Command