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

5
packages/client/lib/sentinel/commands/SENTINEL_MASTER.ts
View File

@@ -3,6 +3,11 @@ import { CommandParser } from '../../client/parser';
import { transformTuplesReply } from '../../commands/generic-transformers';
export default {
/**
* Returns information about the specified master.
* @param parser - The Redis command parser.
* @param dbname - Name of the master.
*/
parseCommand(parser: CommandParser, dbname: RedisArgument) {
parser.push('SENTINEL', 'MASTER', dbname);
},

8
packages/client/lib/sentinel/commands/SENTINEL_MONITOR.ts
View File

@@ -2,6 +2,14 @@ import { CommandParser } from '../../client/parser';
import { RedisArgument, SimpleStringReply, Command } from '../../RESP/types';
export default {
/**
* Instructs a Sentinel to monitor a new master with the specified parameters.
* @param parser - The Redis command parser.
* @param dbname - Name that identifies the master.
* @param host - Host of the master.
* @param port - Port of the master.
* @param quorum - Number of Sentinels that need to agree to trigger a failover.
*/
parseCommand(parser: CommandParser, dbname: RedisArgument, host: RedisArgument, port: RedisArgument, quorum: RedisArgument) {
parser.push('SENTINEL', 'MONITOR', dbname, host, port, quorum);
},

5
packages/client/lib/sentinel/commands/SENTINEL_REPLICAS.ts
View File

@@ -3,6 +3,11 @@ import { RedisArgument, ArrayReply, BlobStringReply, MapReply, Command, TypeMapp
import { transformTuplesReply } from '../../commands/generic-transformers';
export default {
/**
* Returns a list of replicas for the specified master.
* @param parser - The Redis command parser.
* @param dbname - Name of the master.
*/
parseCommand(parser: CommandParser, dbname: RedisArgument) {
parser.push('SENTINEL', 'REPLICAS', dbname);
},

5
packages/client/lib/sentinel/commands/SENTINEL_SENTINELS.ts
View File

@@ -3,6 +3,11 @@ import { RedisArgument, ArrayReply, MapReply, BlobStringReply, Command, TypeMapp
import { transformTuplesReply } from '../../commands/generic-transformers';
export default {
/**
* Returns a list of Sentinel instances for the specified master.
* @param parser - The Redis command parser.
* @param dbname - Name of the master.
*/
parseCommand(parser: CommandParser, dbname: RedisArgument) {
parser.push('SENTINEL', 'SENTINELS', dbname);
},

6
packages/client/lib/sentinel/commands/SENTINEL_SET.ts
View File

@@ -7,6 +7,12 @@ export type SentinelSetOptions = Array<{
}>;
export default {
/**
* Sets configuration parameters for a specific master.
* @param parser - The Redis command parser.
* @param dbname - Name of the master.
* @param options - Configuration options to set as option-value pairs.
*/
parseCommand(parser: CommandParser, dbname: RedisArgument, options: SentinelSetOptions) {
parser.push('SENTINEL', 'SET', dbname);