redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-06 02:15:48 +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/client/lib/commands/WAIT.ts
View File

@@ -4,6 +4,15 @@ import { NumberReply, Command } from '../RESP/types';
export default {
NOT_KEYED_COMMAND: true,
IS_READ_ONLY: true,
/**
* Constructs the WAIT command to synchronize with replicas
*
* @param parser - The command parser
* @param numberOfReplicas - Number of replicas that must acknowledge the write
* @param timeout - Maximum time to wait in milliseconds
* @returns The number of replicas that acknowledged the write
* @see https://redis.io/commands/wait/
*/
parseCommand(parser: CommandParser, numberOfReplicas: number, timeout: number) {
parser.push('WAIT', numberOfReplicas.toString(), timeout.toString());
},