Documentation / @tenancy-node/outbox / OutboxApi

Interface: OutboxApi

Defined in: index.ts:51

Methods

failed()

failed(options?): Promise<OutboxEntry[]>

Defined in: index.ts:59

Dead-letter: eventos que agotaron sus intentos.

Parameters

options?

limit?

number

tenantId?

string

Returns

Promise<OutboxEntry[]>

---

prune()

prune(): Promise<number>

Defined in: index.ts:63

Borra los eventos publicados más antiguos que retentionDays.

Returns

Promise<number>

---

relayOnce()

relayOnce(): Promise<RelayRun>

Defined in: index.ts:53

Procesa un lote ahora (tests, cron).

Returns

Promise<RelayRun>

---

retry()

retry(target): Promise<number>

Defined in: index.ts:61

Vuelve a poner en cola un evento de dead-letter (o todos los de un tenant).

Parameters

target

"all" | { id: string; } | { tenantId: string; }

Returns

Promise<number>

---

startRelay()

startRelay(): object

Defined in: index.ts:55

Corre el relay en segundo plano hasta stop().

Returns

object

stop()

stop(): Promise<void>

Returns

Promise<void>

---

stats()

stats(): Promise<Record<"failed" | "pending" | "processing" | "published", number>>

Defined in: index.ts:57

Cantidad de eventos por estado.

Returns

Promise<Record<"failed" | "pending" | "processing" | "published", number>>