method

RedisClient.xpending

group: string,

...args: string | number[]

): Promise<any>;

Inspect the list of pending messages for a consumer group

@param key

The stream key

@param group

The consumer group name

@param args

Optional IDLE, start, end, count, consumer filters

@returns

Promise that resolves with pending entries information

// Summary form
await redis.xpending("mystream", "mygroup");
// Extended form
await redis.xpending("mystream", "mygroup", "-", "+", 10);

Referenced types