Interface QueueInterface<TMESSAGE>

args

name

params

autoDelete

• autoDelete(autoDelete?: boolean): QueueInterface<TMESSAGE>

  Set the queue to auto delete when the last consumer disconnects. Not allowed for quorum queues or streams

  Parameters

  • OptionalautoDelete: boolean

  Returns QueueInterface<TMESSAGE>

dead

• dead(
      deadLetterExchange: string | ExchangeInterface<unknown>,
      rountingKey?: string,
  ): QueueInterface<TMESSAGE>

  Set the dead letter exchange.

  Parameters

  • deadLetterExchange: string | ExchangeInterface<unknown>
  • OptionalrountingKey: string

  Returns QueueInterface<TMESSAGE>

deliveryLimit

• deliveryLimit(limit: number): QueueInterface<TMESSAGE>

  Set the delivery limit of the queue. Only applicable to quorum queues.

  Parameters

  • limit: number

  Returns QueueInterface<TMESSAGE>

durable

• durable(durable?: boolean): QueueInterface<TMESSAGE>

  Set the queue to be durable. Durable queues will survive a broker restart.

  Parameters

  • Optionaldurable: boolean

  Returns QueueInterface<TMESSAGE>

exclusive

• exclusive(exclusive?: boolean): QueueInterface<TMESSAGE>

  Set the queue to be exclusive. Exclusive queues can only be used by one connection and will be deleted when the connection closes.

  Parameters

  • Optionalexclusive: boolean

  Returns QueueInterface<TMESSAGE>

expires

• expires(ms: number): QueueInterface<TMESSAGE>

  Delete the queue after the given time in milliseconds of disuse.

  Parameters

  • ms: number

  Returns QueueInterface<TMESSAGE>

maxAge

• maxAge(
      maxAge:
          | `${number}Y`
          | `${number}M`
          | `${number}D`
          | `${number}h`
          | `${number}m`
          | `${number}s`,
  ): QueueInterface<TMESSAGE>

  Set the max age of the messages in the stream. Retention is only evaluated when a new segment is added to the stream. Valid units are: Y, M, D, h, m, s

  Parameters

  • maxAge:
        | `${number}Y`
        | `${number}M`
        | `${number}D`
        | `${number}h`
        | `${number}m`
        | `${number}s`

  Returns QueueInterface<TMESSAGE>

maxLength

• maxLength(
      maxLength: number,
      overflowBehavior?: XOverflow,
  ): QueueInterface<TMESSAGE>

  Set the max length of the queue.

  Parameters

  • maxLength: number
  • OptionaloverflowBehavior: XOverflow

  Returns QueueInterface<TMESSAGE>

maxLengthBytes

• maxLengthBytes(
      maxLengthBytes: number,
      overflowBehavior?: XOverflow,
  ): QueueInterface<TMESSAGE>

  Set the max length of the queue in bytes.

  Parameters

  • maxLengthBytes: number
  • OptionaloverflowBehavior: XOverflow

  Returns QueueInterface<TMESSAGE>

maxPriority

• maxPriority(priority: number): QueueInterface<TMESSAGE>

  Set maximum priority of the messages in the queue. Larger numbers indicate higher priority.

  Parameters

  • priority: number

  Returns QueueInterface<TMESSAGE>

messageTtl

• messageTtl(ttl: number): QueueInterface<TMESSAGE>

  Set message TTL. Messages in the queue will be expired after the TTL. If dead letter exchange is set, expired messages will be sent to the dead letter exchange.

  Parameters

  • ttl: number

  Returns QueueInterface<TMESSAGE>

passive

• passive(passive?: boolean): QueueInterface<TMESSAGE>

  Set the queue to be passive. Passive queues will not be created by the broker.

  Parameters

  • Optionalpassive: boolean

  Returns QueueInterface<TMESSAGE>

quorum

• quorum(): QueueInterface<TMESSAGE>

  Set the queue type to quorum. See https://www.rabbitmq.com/quorum-queues.html

  Returns QueueInterface<TMESSAGE>

setArgument

• setArgument(
      key: string,
      value: undefined | string | number | boolean,
  ): QueueInterface<TMESSAGE>

  Parameters

  • key: string
  • value: undefined | string | number | boolean

  Returns QueueInterface<TMESSAGE>

singleActiveConsumer

• singleActiveConsumer(): QueueInterface<TMESSAGE>

  Set the queue to have a single active consumer. See https://www.rabbitmq.com/consumers.html#single-active-consumer

  Returns QueueInterface<TMESSAGE>

stream

• stream(): QueueInterface<TMESSAGE>

  Set the queue type to stream. See https://www.rabbitmq.com/streams.html

  Returns QueueInterface<TMESSAGE>

streamMaxSegmentSize

• streamMaxSegmentSize(bytes: number): QueueInterface<TMESSAGE>

  Set the max segment size of the stream. A stream is divided up into fixed size segment files on disk. This setting controls the size of these. Default: (500_000_000 bytes).

  Parameters

  • bytes: number

  Returns QueueInterface<TMESSAGE>