Connectum API Reference / @connectum/events-nats / types / NatsAdapterOptions

Interface: NatsAdapterOptions

Defined in: types.ts:12

Options for creating a NATS JetStream adapter.

Properties

connectionOptions?

readonly optional connectionOptions: Partial<NodeConnectionOptions>

Defined in: types.ts:32

NATS connection options (escape hatch for advanced config).

The servers field from this object is overridden by the top-level servers option.

---

consumerOptions?

readonly optional consumerOptions: NatsConsumerOptions

Defined in: types.ts:35

JetStream consumer tuning options.

---

servers

readonly servers: string | string[]

Defined in: types.ts:14

NATS server URL(s). Accepts a single string or an array.

---

stream?

readonly optional stream: string

Defined in: types.ts:24

JetStream stream name.

When set, subjects are prefixed with {stream}. and the stream is auto-created on connect() if it does not exist.

Default

"events"