AnyJobQueue interface

What every queue in this package can do regardless of which end it is: report its name, expose its logger, and start, stop or tear down its broker connection.

T is the implementing type itself, so that start and stop resolve to the concrete queue and stay chainable.

Signature:

export interface AnyJobQueue<T> 

Properties

Property

Modifiers

Type

Description

logger

readonly

ILogger

Logger this queue reports through, either the one supplied in JobQueueOptions.logger or console.

name

string

Name of this queue, as given in JobQueueOptions.name. Read-only — a queue cannot be re-pointed after construction.

Methods

Method

Description

destroy()

Closes the broker connection and releases the queue's resources for good. Unlike AnyJobQueue.stop() this is not reversible.

start()

Opens the broker connection and begins processing, resolving to this queue.

stop()

Stops processing, resolving to this queue. The queue can be started again.

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