Skip to main content

OrderedEventOverrides

@horizon-republic/nestjs-jetstream


@horizon-republic/nestjs-jetstream / OrderedEventOverrides

OrderedEventOverrides

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

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​

consumer?​

optional consumer?: Partial<Omit<OrderedConsumerOptions, "filter_subjects">>

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

Raw nats.js ordered-consumer options, in the same place and the same spelling the other kinds use for their consumer block.

filter_subjects is derived from the registered handlers and is not settable. Leaving deliver_policy unset reads from the beginning, which is what DeliverPolicy.All means.


management?​

optional management?: ManagementMode

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

Provisioning control for the ordered stream. Falls back to provisioning.management.

A scalar rather than EntityManagement: ordered consumers are ephemeral and owned by the nats.js client, so only the stream has a provisioning decision to make.


stream?​

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

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

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


subjectPrefix?​

optional subjectPrefix?: string

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

Custom subject prefix (trailing dot normalized), e.g. 'company.orders.'.