Stream

XDEL

Removes the specified entries from a stream, and returns the number of entries deleted.

Arguments

keybodystringrequired

The key of the stream.

idsbodystring | string[]required

The ID(s) of the message(s) to delete. Can be a single ID or an array of IDs.

Response

number

The number of entries actually deleted from the stream.

Single message
const result = await redis.xdel("mystream", "1638360173533-0");
Multiple messages
const result = await redis.xdel("mystream", [  "1638360173533-0",  "1638360173533-1",  "1638360173533-2"]);
Loading search…