XPENDING

Returns information about pending messages in a stream consumer group.

1 min read

Arguments#

keystringrequired#

The key of the stream.

groupstringrequired#

The consumer group name.

startstringrequired#

The minimum pending ID to return. Use "-" for the first available ID.

endstringrequired#

The maximum pending ID to return. Use "+" for the last available ID.

countnumberrequired#

The maximum number of pending messages to return.

options#

Show properties

idleTimenumber#

Filter by minimum idle time in milliseconds.

consumerstring#

Filter results by a specific consumer.

Response#

XLEN XRANGE

const result = await redis.xpending("mystream", "mygroup", "-", "+", 10);

[  2, // total pending count  "1638360173533-0", // smallest pending ID  "1638360173533-1", // greatest pending ID  [    ["consumer1", "1"], // consumer and their pending count    ["consumer2", "1"]  ]]