interface RedisBrokerOptions

export declare interface RedisBrokerOptions extends BaseBrokerOptions

Options specific for a Redis broker

optional
blockTimeout? : number

How long to block for messages when polling

Inherited from: BaseBrokerOptions

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

Function to use for decoding messages

Inherited from: BaseBrokerOptions

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

Function to use for encoding messages

Inherited from: BaseBrokerOptions

optional
maxChunk? : number

Max number of messages to poll at once

Inherited from: BaseBrokerOptions

optional
name? : string

Unique consumer name.

Inherited from: BaseBrokerOptions

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

redisClient : Redis

The Redis client to use