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

13
packages/client/lib/commands/PUBSUB_SHARDNUMSUB.ts
View File

@@ -4,6 +4,13 @@ import { RedisVariadicArgument } from './generic-transformers';
export default {
IS_READ_ONLY: true,
/**
* Constructs the PUBSUB SHARDNUMSUB command
*
* @param parser - The command parser
* @param channels - Optional shard channel names to get subscription count for
* @see https://redis.io/commands/pubsub-shardnumsub/
*/
parseCommand(parser: CommandParser, channels?: RedisVariadicArgument) {
parser.push('PUBSUB', 'SHARDNUMSUB');
@@ -11,6 +18,12 @@ export default {
parser.pushVariadic(channels);
}
},
/**
* Transforms the PUBSUB SHARDNUMSUB reply into a record of shard channel name to subscriber count
*
* @param reply - The raw reply from Redis
* @returns Record mapping shard channel names to their subscriber counts
*/
transformReply(reply: UnwrapReply<ArrayReply<BlobStringReply | NumberReply>>) {
const transformedReply: Record<string, NumberReply> = Object.create(null);