interface RedisBrokerOptions

export interface RedisBrokerOptions extends BaseBrokerOptions

Options specific for a Redis broker

blockTimeout
decode
encode
group
maxChunk
maxDeliveredTimes
messageIdleTime
name

optional
blockTimeout? : number

How long to block for messages when polling

optional
decode? : (data: Buffer) => unknown

Function to use for decoding messages

Inherited from: BaseBrokerOptions

optional
encode? : (data: unknown) => Buffer

Function to use for encoding messages

Inherited from: BaseBrokerOptions

group : string | typeof kUseRandomGroupName

Consumer group name to use for this broker. For fanning out events, use kUseRandomGroupName

See also: https://redis.io/commands/xreadgroup/

optional
maxChunk? : number

Max number of messages to poll at once

optional
maxDeliveredTimes? : number

How many times a message can be delivered to a consumer before it is considered dead. This is used to prevent messages from being stuck in the queue forever if a consumer is unable to process them.

optional
messageIdleTime? : number

How long a message should be idle for before allowing it to be claimed by another consumer. Note that too high of a value can lead to a high delay in processing messages during a service downscale, while too low of a value can lead to messages being too eagerly claimed by other consumers during an instance restart (which is most likely not actually that problematic)

name : string

Unique consumer name.

See also: https://redis.io/commands/xreadgroup/