OrderedEventOverrides

Defined in: src/interfaces/options.interface.ts:106

Configuration for ordered event consumers.

Ordered consumers use Limits retention and deliver messages in strict sequential order with at-most-once delivery. No ack/nak/DLQ.

Only a subset of consumer options applies — ordered consumers are ephemeral and auto-managed by nats.js.

Properties

deliverPolicy?

optional deliverPolicy?: DeliverPolicy

Defined in: src/interfaces/options.interface.ts:114

Where to start reading when the consumer is (re)created.

Default

DeliverPolicy.All

---

optStartSeq?

optional optStartSeq?: number

Defined in: src/interfaces/options.interface.ts:119

Start sequence number. Only used when deliverPolicy is StartSequence.

---

optStartTime?

optional optStartTime?: string

Defined in: src/interfaces/options.interface.ts:124

Start time (ISO string). Only used when deliverPolicy is StartTime.

---

replayPolicy?

optional replayPolicy?: ReplayPolicy

Defined in: src/interfaces/options.interface.ts:130

Replay policy for historical messages.

Default

ReplayPolicy.Instant

---

stream?

optional stream?: Partial<Omit<StreamConfig, "retention">>

Defined in: src/interfaces/options.interface.ts:108

Stream overrides (e.g. max_age, max_bytes).