XCLAIM - 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.

idsstring | string[]required#

The ID(s) of the message(s) to claim. Can be a single ID or an array of IDs.

options#

Show options

idlenumber#

Set the idle time of the message.

timenumber#

Set the idle time to a specific Unix time.

retryCountnumber#

Set the retry counter to the specified value.

forceboolean#

Create the pending message entry even if certain IDs are not already pending.

justidboolean#

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

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

Returns an array of claimed messages. If justid option is used, returns only message IDs.