IMessageQueueAuthConnection interface

Optional credentials for a queue host, forwarded to the Redis client as username and password, plus the transport security to reach it with.

Supply both credentials for a Redis ACL user, or just password for a requirepass-only server. Omit both to connect unauthenticated, which is the default.

Signature:

export interface IMessageQueueAuthConnection

Properties

Property

Modifiers

Type

Description

password?

string

(Optional) Password for the queue host.

tls?

boolean | TlsOptions

(Optional) Encrypts this connection with TLS. true connects with Node's defaults, verifying the server against the system trust store; an object is handed to tls.connect() as given, so supply ca for a private certificate authority and cert with key for mutual TLS.

Applies to every channel the queue opens — reader, writer, watcher and subscription alike — so enabling it here encrypts the whole bus. The broker must be listening for TLS (tls-port); a server that is not will refuse the handshake rather than fall back to plaintext.

username?

string

(Optional) Redis ACL user name. Omit for a server that only uses requirepass.

Read this page as plain markdown — no HTML, no navigation. For pasting into an LLM, or for an agent to fetch.