1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-04 15:02:09 +03:00
Files
node-redis/packages/client/lib/commands/XGROUP_CREATECONSUMER.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

31 lines
967 B
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, Command, NumberReply } from '../RESP/types';
/**
* Command for creating a new consumer in a consumer group
*/
export default {
IS_READ_ONLY: false,
/**
* Constructs the XGROUP CREATECONSUMER command to create a new consumer in a consumer group
*
* @param parser - The command parser
* @param key - The stream key
* @param group - Name of the consumer group
* @param consumer - Name of the consumer to create
* @returns 1 if the consumer was created, 0 if it already existed
* @see https://redis.io/commands/xgroup-createconsumer/
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
group: RedisArgument,
consumer: RedisArgument
) {
parser.push('XGROUP', 'CREATECONSUMER');
parser.pushKey(key);
parser.push(group, consumer);
},
transformReply: undefined as unknown as () => NumberReply
} as const satisfies Command;