Skip to main content

​
Arguments

​
key
string
required
The key of the stream.
​
group
string
required
The consumer group name.
​
consumer
string
required
The consumer name that will claim the messages.
​
minIdleTime
number
required
The minimum idle time in milliseconds for messages to be claimed.
​
start
string
required
The stream entry ID to start claiming from.
​
options
object

​
Response

Returns a tuple containing:
  • Next start ID for pagination
  • Array of claimed messages (ID and field-value pairs)
  • Array of deleted message IDs
const result = await redis.xautoclaim(
  "mystream",
  "mygroup", 
  "consumer1",
  60000,
  "0-0"
);

[
  "1638360173533-1", // next start ID
  [["1638360173533-0", ["field1", "value1", "field2", "value2"]]], // claimed messages
  [] // deleted message IDs
]
⌘I