method

RedisClient.xclaim

key: KeyLike,
group: string,
consumer: string,
minIdleTime: number,
id: string,
...rest: string | number[]
): Promise<any>;

Change the ownership of pending messages in a consumer group

@param key

The stream key

@param group

The consumer group name

@param consumer

The consumer that will claim the messages

@param minIdleTime

Claim only messages idle for at least this many milliseconds

@param id

The first message ID to claim

@param rest

Additional message IDs and optional IDLE/TIME/RETRYCOUNT/FORCE/JUSTID modifiers

@returns

Promise that resolves with the claimed entries

Referenced types

type KeyLike = string | ArrayBufferView | Blob