1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
node-redis/packages/client/lib/commands/SPUBLISH.ts
Bobby I. 20c16e0c2c (docs) add jsdoc comments to command parsers (#2984)
* (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
2025-06-03 14:38:07 +03:00

21 lines
706 B
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, NumberReply, Command } from '../RESP/types';
export default {
IS_READ_ONLY: true,
/**
* Constructs the SPUBLISH command to post a message to a Sharded Pub/Sub channel
*
* @param parser - The command parser
* @param channel - The channel to publish to
* @param message - The message to publish
* @see https://redis.io/commands/spublish/
*/
parseCommand(parser: CommandParser, channel: RedisArgument, message: RedisArgument) {
parser.push('SPUBLISH');
parser.pushKey(channel);
parser.push(message);
},
transformReply: undefined as unknown as () => NumberReply
} as const satisfies Command;