Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueueOptions

Hierarchy

  • QueueOptions

Index

Properties

Optional arguments

arguments: {}

a map of additional arguments to pass in when creating a queue

Type declaration

  • [arg: string]: any

Optional autoDelete

autoDelete: boolean

Default: true

If set, the queue is deleted when all consumers have finished using it.

Last consumer can be cancelled either explicitly or because its channel is closed.

If there was no consumer ever on the queue, it won't be deleted

Optional closeChannelOnUnsubscribe

closeChannelOnUnsubscribe: boolean

Default: false

when true the channel will close on unsubscribe

Optional durable

durable: boolean

Default: false

Durable queues remain active when a server restarts.

Non-durable queues (transient queues) are purged if/when a server restarts.

Note that durable queues do not necessarily hold persistent messages, although it does not make sense to send persistent messages to a transient queue

Optional exclusive

exclusive: boolean

Default: false

Exclusive queues may only be consumed from by the current connection.

Setting the 'exclusive' flag always implies 'autoDelete'

Optional noDeclare

noDeclare: boolean

Default: false

If set, the queue will not be declared, this will allow a queue to be deleted if you don't know its previous options

Optional passive

passive: boolean

Default: false

If set, the server will not create the queue.

The client can use this to check whether a queue exists without modifying the server state

Generated using TypeDoc