You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-04 15:02:09 +03:00
20c16e0c2c
* (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
31 lines
961 B
TypeScript
31 lines
961 B
TypeScript
import { CommandParser } from '../client/parser';
|
|
import { RedisArgument, NumberReply, Command } from '../RESP/types';
|
|
|
|
/**
|
|
* Command for removing a consumer from a consumer group
|
|
*/
|
|
export default {
|
|
IS_READ_ONLY: false,
|
|
/**
|
|
* Constructs the XGROUP DELCONSUMER command to remove a consumer from 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 remove
|
|
* @returns The number of pending messages owned by the deleted consumer
|
|
* @see https://redis.io/commands/xgroup-delconsumer/
|
|
*/
|
|
parseCommand(
|
|
parser: CommandParser,
|
|
key: RedisArgument,
|
|
group: RedisArgument,
|
|
consumer: RedisArgument
|
|
) {
|
|
parser.push('XGROUP', 'DELCONSUMER');
|
|
parser.pushKey(key);
|
|
parser.push(group, consumer);
|
|
},
|
|
transformReply: undefined as unknown as () => NumberReply
|
|
} as const satisfies Command;
|