XAUTOCLAIM - Upstash Documentation

Arguments#

keystringrequired#

The key of the stream.

groupstringrequired#

The consumer group name.

consumerstringrequired#

The consumer name that will claim the messages.

minIdleTimenumberrequired#

The minimum idle time in milliseconds for messages to be claimed.

startstringrequired#

The stream entry ID to start claiming from.

optionsobject#

Show options

countnumber#

The maximum number of messages to claim.

justidboolean#

Return only the message IDs instead of the full message data.

Response#

[string, Array<[string, string[]]>, string[]]

Returns a tuple containing:

Next start ID for pagination
Array of claimed messages (ID and field-value pairs)
Array of deleted message IDs

XADD XCLAIM

const result = await redis.xautoclaim(  "mystream",  "mygroup",   "consumer1",  60000,  "0-0");

const result = await redis.xautoclaim(  "mystream",  "mygroup",  "consumer1",   60000,  "0-0",  { count: 5, justid: true });

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