redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-12-12 21:21:15 +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

9
packages/search/lib/commands/SYNUPDATE.ts
View File

@@ -9,6 +9,15 @@ export interface FtSynUpdateOptions {
export default {
NOT_KEYED_COMMAND: true,
IS_READ_ONLY: true,
/**
* Updates a synonym group with new terms.
* @param parser - The command parser
* @param index - Name of the index that contains the synonym group
* @param groupId - ID of the synonym group to update
* @param terms - One or more synonym terms to add to the group
* @param options - Optional parameters:
* - SKIPINITIALSCAN: Skip the initial scan for existing documents
*/
parseCommand(
parser: CommandParser,
index: RedisArgument,