redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-12-14 09:42:12 +03:00
Code Activity

(docs) add jsdoc comments to command parsers (#2984)

Browse Source 
* (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
This commit is contained in:
Bobby I.
2025-06-03 14:38:07 +03:00
committed by GitHub
parent e4a1ca467f
commit 20c16e0c2c
491 changed files with 3861 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/search/lib/commands/SUGGET_WITHSCORES.ts
View File

@@ -9,6 +9,14 @@ type SuggestScore = {
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');