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/XACKDEL.ts
Pavel Pashov d941ec5a4c Add Redis 8.2 New Stream Commands (#3029)
* chore: update Redis version from 8.2-RC1-pre to 8.2-rc1

* feat: implement XDELEX command for Redis 8.2

* feat: implement XACKDEL command for Redis 8.2

* refactor: create shared stream deletion types
  for Redis 8.2 commands

* feat: add Redis 8.2 deletion policies to XTRIM
  command

* feat: add Redis 8.2 deletion policies to XADD commands

* fix: correct XDELEX command method name and test parameter
2025-07-25 17:58:28 +03:00

46 lines
1.4 KiB
TypeScript

import { CommandParser } from "../client/parser";
import { RedisArgument, ArrayReply, Command } from "../RESP/types";
import {
StreamDeletionReplyCode,
StreamDeletionPolicy,
} from "./common-stream.types";
import { RedisVariadicArgument } from "./generic-transformers";
/**
* Acknowledges and deletes one or multiple messages for a stream consumer group
*/
export default {
IS_READ_ONLY: false,
/**
* Constructs the XACKDEL command to acknowledge and delete one or multiple messages for a stream 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 and delete
* @param policy - Policy to apply when deleting entries (optional, defaults to KEEPREF)
* @returns Array of integers: -1 (not found), 1 (acknowledged and deleted), 2 (acknowledged with dangling refs)
* @see https://redis.io/commands/xackdel/
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
group: RedisArgument,
id: RedisVariadicArgument,
policy?: StreamDeletionPolicy
) {
parser.push("XACKDEL");
parser.pushKey(key);
parser.push(group);
if (policy) {
parser.push(policy);
}
parser.push("IDS");
parser.pushVariadicWithLength(id);
},
transformReply:
undefined as unknown as () => ArrayReply<StreamDeletionReplyCode>,
} as const satisfies Command;