JetStreamConsumerConfig

JetStreamConsumerConfig = object

Defined in: src/io/broker/JetStreamActor.ts:116

Push or pull consumer config (#62).

Properties

ackPolicy?

readonly optional ackPolicy?: "explicit" | "none" | "all"

Defined in: src/io/broker/JetStreamActor.ts:135

'explicit' (default — ack/nak/term required), 'none', or 'all'.

---

ackWaitMs?

readonly optional ackWaitMs?: number

Defined in: src/io/broker/JetStreamActor.ts:137

Max time before the consumer redelivers without an ack. Default 30s.

---

create?

readonly optional create?: boolean

Defined in: src/io/broker/JetStreamActor.ts:143

Auto-create or update at connect time. Default true.

---

deliverPolicy?

readonly optional deliverPolicy?: "all" | "last" | "new" | { kind: "byStartSeq"; startSeq: number; } | { kind: "byStartTime"; startTimeMs: number; }

Defined in: src/io/broker/JetStreamActor.ts:130

Where in the stream to start the new consumer. Default 'all'.

---

durable

readonly durable: string

Defined in: src/io/broker/JetStreamActor.ts:118

Durable name — required so the consumer survives restarts.

---

filterSubject?

readonly optional filterSubject?: string

Defined in: src/io/broker/JetStreamActor.ts:139

Subject filter — defaults to all subjects in the stream.

---

maxAcknowledgmentPending?

readonly optional maxAcknowledgmentPending?: number

Defined in: src/io/broker/JetStreamActor.ts:141

Max in-flight unacked messages. Default 1024 (server default).

---

mode?

readonly optional mode?: "push" | "pull"

Defined in: src/io/broker/JetStreamActor.ts:128

Consumer mode (#62). 'push' (default) — server pushes messages; the actor’s internal pump iterates the subscription and waits per-message for ack/nak/term. 'pull' — caller drives fetches with { kind: 'fetch', batch, expiresMs } commands; messages within a fetch still go through the same ack handshake. Pull mode lets the application self-pace, which fits slow/bursty consumers better than push fan-out.