cleanup

boolean

Turns on/off cleanup of the message queues

{boolean}

cleanupFilter

string

Cleanup pattern for queue names that should be removed during cleanup

{string}

cluster?

IMessageQueueConnection[]

(Optional) Queue cluster instances, if MQ should be clustered

{IMessageQueueConnection[]}

clusterManagers?

ClusterManager[]

(Optional) Array of cluster managers used to handle cluster operations. Any manager implements specific cluster server detection.

{ClusterManager[]}

handleSignals?

boolean

(Optional) Enable process signal handling (SIGTERM, SIGINT, SIGABRT) by the queue. When enabled, the queue releases its watcher lock and exits gracefully on these signals. Disable if the host application manages shutdown.

true {boolean}

logger?

ILogger

(Optional) Logger instance to use for message queue logging at runtime

{ILogger}

prefix?

string

(Optional) Message queue global key prefix (namespace)

{string}

safeDelivery?

boolean

(Optional) Enable guaranteed message delivery. When enabled, uses a more complex algorithm for message handling, ensuring that if a worker fails, the message will be delivered to another worker. Required only for systems that demand guaranteed delivery semantics.

{boolean}

safeDeliveryTtl?

number

(Optional) Time-to-live (in milliseconds) for messages in worker queues. After this period, unacknowledged messages return to the main queue for reprocessing if the worker died. Only effective when safeDelivery is enabled.

{number}

useGzip?

boolean

(Optional) Enable message compression for serialization. Increases a worker CPU load but decreases network traffic between workers and the queue host.

{boolean}

vendor?

string

(Optional) Message queue vendor

{string}

verbose?

boolean

(Optional) Enables/disables verbose logging

false {boolean}

verboseExtended?

boolean

(Optional) Enables/disables extended verbose logging. The output may contain sensitive information, so use it with caution. Does not work if a verbose option is disabled.

false {boolean}

watcherCheckDelay?

number

(Optional) Delay period (in milliseconds) between watcher availability checks. Used to ensure at least one watcher is available for queue operations.

{number}