Documentation / @tenancy-node/transport-redis-streams / RedisStreamConsumerOptions

Interface: RedisStreamConsumerOptions

Defined in: index.ts:59

Properties

batch?

optional batch?: number

Defined in: index.ts:71

---

blockMs?

optional blockMs?: number

Defined in: index.ts:72

---

claimIdleMs?

optional claimIdleMs?: number

Defined in: index.ts:70

Mensajes pendientes con más de este tiempo se retoman de consumidores caídos. Por defecto 30 s.

---

consumer

consumer: string

Defined in: index.ts:66

Nombre de esta instancia dentro del grupo.

---

deadLetterStream?

optional deadLetterStream?: string

Defined in: index.ts:79

Stream donde se copian los mensajes descartados (agotaron maxAttempts o no traen un CloudEvent válido), con el campo error. Por defecto no se copian.

---

group

group: string

Defined in: index.ts:64

Grupo de consumidores (cada microservicio usa el suyo).

---

handler

handler: (event) => Promise<void>

Defined in: index.ts:68

Si lanza, el mensaje no se confirma y se reintenta (lo retoma XAUTOCLAIM) hasta maxAttempts.

Parameters

event

CloudEvent

Returns

Promise<void>

---

maxAttempts?

optional maxAttempts?: number

Defined in: index.ts:74

Entregas antes de descartar un mensaje que siempre falla (se confirma). Por defecto 5.

---

onError?

optional onError?: (error, event) => void

Defined in: index.ts:81

Recibe cada fallo del handler, los mensajes descartados y los errores de conexión del bucle.

Parameters

error

unknown

event

CloudEvent<unknown> | undefined

Returns

void

---

redisOptions?

optional redisOptions?: RedisOptions

Defined in: index.ts:61

---

stream?

optional stream?: string

Defined in: index.ts:62

---

url?

optional url?: string

Defined in: index.ts:60