RedisQueue.(constructor)

Creates a queue handle. No connection is opened here — call RedisQueue.start(), or RedisQueue.send(), which starts the queue implicitly.

Signature:

constructor(
    name: string, options?: Partial<IMQOptions>, mode?: IMQMode);

Parameters

Parameter	Type	Description
name	string	queue name; the underlying Redis list key becomes `<prefix>:<name>`
options	Partial<IMQOptions>	(Optional) partial options merged over DEFAULT_IMQ_OPTIONS
mode	IMQMode	(Optional) whether this handle produces, consumes, or both; defaults to IMQMode.BOTH

Remarks

The constructor performs no I/O. It resolves the effective options, selects the serializer pair from IMQOptions.useGzip once, and derives the host:port key under which the shared connections are stored — so changing useGzip, host or port on options afterwards has no effect.

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