1
0
mirror of https://github.com/redis/node-redis.git synced 2025-12-11 09:22:35 +03:00
Files
node-redis/packages/search/lib/commands/SUGGET_WITHSCORES.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

57 lines
2.0 KiB
TypeScript

import { NullReply, ArrayReply, BlobStringReply, DoubleReply, UnwrapReply, Command, TypeMapping } from '@redis/client/dist/lib/RESP/types';
import { isNullReply, transformDoubleReply } from '@redis/client/dist/lib/commands/generic-transformers';
import SUGGET from './SUGGET';
type SuggestScore = {
suggestion: BlobStringReply;
score: DoubleReply;
}
export default {
IS_READ_ONLY: SUGGET.IS_READ_ONLY,
/**
* Gets completion suggestions with their scores from a suggestion dictionary.
* @param args - Same parameters as FT.SUGGET:
* - parser: The command parser
* - key: The suggestion dictionary key
* - prefix: The prefix to get completion suggestions for
* - options: Optional parameters for fuzzy matching and max results
*/
parseCommand(...args: Parameters<typeof SUGGET.parseCommand>) {
SUGGET.parseCommand(...args);
args[0].push('WITHSCORES');
},
transformReply: {
2: (reply: NullReply | UnwrapReply<ArrayReply<BlobStringReply>>, preserve?: any, typeMapping?: TypeMapping) => {
if (isNullReply(reply)) return null;
const transformedReply: Array<SuggestScore> = new Array(reply.length / 2);
let replyIndex = 0,
arrIndex = 0;
while (replyIndex < reply.length) {
transformedReply[arrIndex++] = {
suggestion: reply[replyIndex++],
score: transformDoubleReply[2](reply[replyIndex++], preserve, typeMapping)
};
}
return transformedReply;
},
3: (reply: UnwrapReply<ArrayReply<BlobStringReply | DoubleReply>>) => {
if (isNullReply(reply)) return null;
const transformedReply: Array<SuggestScore> = new Array(reply.length / 2);
let replyIndex = 0,
arrIndex = 0;
while (replyIndex < reply.length) {
transformedReply[arrIndex++] = {
suggestion: reply[replyIndex++] as BlobStringReply,
score: reply[replyIndex++] as DoubleReply
};
}
return transformedReply;
}
}
} as const satisfies Command;