interface RedisBrokerOptions

export interface RedisBrokerOptions extends BaseBrokerOptions

Options specific for a Redis broker

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

Consumer group name to use for this broker

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

optional
maxChunk? : number

Max number of messages to poll at once

optional
name? : string

Unique consumer name.

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