ProvisioningOptions

@horizon-republic/nestjs-jetstream

---

@horizon-republic/nestjs-jetstream / ProvisioningOptions

ProvisioningOptions

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

Provisioning behavior. Stream reservations are always logged at boot (INFO).

Properties

allowDestructiveMigration?

optional allowDestructiveMigration?: boolean

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

Allow destructive stream migration when immutable config changes are detected.

When true, the transport recreates streams via blue-green sourcing if an immutable property such as storage differs from the running stream. Messages are preserved during migration.

retention is NOT migratable: it is controlled by the transport (Workqueue for events, Limits for broadcast/ordered) and a mismatch is always an error regardless of this flag.

When false (default), immutable conflicts are logged as warnings and the stream keeps its existing configuration.

Default

false

---

management?

optional management?: ManagementMode

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

Default management mode for every stream and consumer.

Default

ManagementMode.Auto

---

preflightStorageCheck?

optional preflightStorageCheck?: boolean

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

Opt-in storage budget check via getAccountInfo() before provisioning. Warn-only; never blocks boot. Off by default.