1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
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
928 B
TypeScript

import { CommandParser } from '../client/parser';
import { NumberReply, Command, RedisArgument } from '../RESP/types';
import { RedisVariadicArgument } from './generic-transformers';
export default {
IS_READ_ONLY: false,
/**
* Constructs the XACK command to acknowledge the processing of stream messages in a consumer group
*
* @param parser - The command parser
* @param key - The stream key
* @param group - The consumer group name
* @param id - One or more message IDs to acknowledge
* @returns The number of messages successfully acknowledged
* @see https://redis.io/commands/xack/
*/
parseCommand(parser: CommandParser, key: RedisArgument, group: RedisArgument, id: RedisVariadicArgument) {
parser.push('XACK');
parser.pushKey(key);
parser.push(group)
parser.pushVariadic(id);
},
transformReply: undefined as unknown as () => NumberReply
} as const satisfies Command;