You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-06 02:15:48 +03:00
(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
This commit is contained in:
@@ -1,8 +1,20 @@
|
||||
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);
|
||||
|
Reference in New Issue
Block a user