Appearance

API reference@connectum/events-redisDocs 1.3.x

Connectum API Reference / @connectum/events-redis / types / RedisBrokerOptions

Interface: RedisBrokerOptions ​

Defined in: types.ts:41

Redis Streams broker tuning options.

Properties ​

blockMs? ​

readonly optional blockMs?: number

Defined in: types.ts:59

Block timeout in milliseconds for XREADGROUP.

How long the consumer blocks waiting for new messages before retrying the loop.

Default ​

ts
5000

count? ​

readonly optional count?: number

Defined in: types.ts:66

Number of messages to read per XREADGROUP call.

Default ​

ts
10

maxLen? ​

readonly optional maxLen?: number

Defined in: types.ts:49

Maximum stream length (MAXLEN approximate for XADD).

When set, older entries are trimmed on publish.

Default ​

ts
undefined (no limit)