API reference / @node-ts/bus-rabbitmq / RabbitMqTransportConfiguration
Interface: RabbitMqTransportConfiguration
Defined in: packages/bus-rabbitmq/src/rabbitmq-transport-configuration.ts:4
A common set of transport configuration options. This should be extended by a provider-specific configuration that augments it with further options.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
connectionRecovery? | RabbitMqConnectionRecoveryConfiguration | How to reconnect when the connection or channel to RabbitMQ is lost. After reconnecting, the transport re-declares its exchanges, queues and bindings and resumes consuming. The initial connection in connect() isn't retried and fails straight away if the broker can't be reached. Default { enabled: true, initialDelay: 100, maxDelay: 30000, factor: 2, jitter: 0.2, maxRetries: Infinity } | - | packages/bus-rabbitmq/src/rabbitmq-transport-configuration.ts:29 |
connectionString | string | The amqp connection string to use to connect to the rabbit mq instance Example amqp://guest:guest@localhost | - | packages/bus-rabbitmq/src/rabbitmq-transport-configuration.ts:9 |
deadLetterQueueName? | string | An optional name of the dead letter queue to fail messages to Default dead-letter Example order-booking-service-dlq | TransportConfiguration.deadLetterQueueName | packages/bus-core/dist/transport/transport-configuration.d.ts:16 |
maxRetries? | number | The maximum number of attempts to retry a failed message before routing it to the dead letter queue. The delay between attempts comes from the bus's retry strategy (withRetryStrategy). Default 10 | - | packages/bus-rabbitmq/src/rabbitmq-transport-configuration.ts:16 |
persistentMessages? | boolean | Whether the messages in RabbitMQ are persistent or not (survive a broker restart). By default, false. | - | packages/bus-rabbitmq/src/rabbitmq-transport-configuration.ts:21 |
queueName | string | The name of the queue that receives incoming messages Example order-booking-service | TransportConfiguration.queueName | packages/bus-core/dist/transport/transport-configuration.d.ts:10 |