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/XGROUP_DESTROY.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

25 lines
809 B
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, NumberReply, Command } from '../RESP/types';
/**
* Command for removing a consumer group
*/
export default {
IS_READ_ONLY: false,
/**
* Constructs the XGROUP DESTROY command to remove a consumer group
*
* @param parser - The command parser
* @param key - The stream key
* @param group - Name of the consumer group to destroy
* @returns 1 if the group was destroyed, 0 if it did not exist
* @see https://redis.io/commands/xgroup-destroy/
*/
parseCommand(parser: CommandParser, key: RedisArgument, group: RedisArgument) {
parser.push('XGROUP', 'DESTROY');
parser.pushKey(key);
parser.push(group);
},
transformReply: undefined as unknown as () => NumberReply
} as const satisfies Command;