XINFO - Upstash Documentation

Arguments#

keystringrequired#

The key of the stream.

optionsobjectrequired#

The XINFO subcommand options. Can be one of:

Show GROUPS

type'GROUPS'required#

List all consumer groups for the stream.

Show CONSUMERS

type'CONSUMERS'required#

List all consumers in a consumer group.

groupstringrequired#

The consumer group name.

Response#

The return type depends on the subcommand:

GROUPS: Returns an array of consumer group information
CONSUMERS: Returns an array of consumer information

// GROUPS response[ { name: "mygroup", consumers: 2, pending: 1, "last-delivered-id": "1638360173533-2", "entries-read": 3, lag: 2 }]// CONSUMERS response[ { name: "consumer1", pending: 1, idle: 15000, "inactive": 15000 }]