Class AMQPQueue

Readonlyname

bind

• bind(
      exchange: string,
      routingKey?: string,
      args?: Record<string, unknown>,
  ): Promise<AMQPQueue>

  Bind this queue to an exchange.

  Parameters

  • exchange: string
  • routingKey: string = ""
  • args: Record<string, unknown> = {}

  Returns Promise<AMQPQueue>

  this for chaining

delete

• delete(
      params?: { ifEmpty?: boolean; ifUnused?: boolean },
  ): Promise<MessageCount>

  Delete this queue.

  Parameters

  • Optionalparams: { ifEmpty?: boolean; ifUnused?: boolean }

    • OptionalifEmpty?: boolean

      only delete if the queue is empty

    • OptionalifUnused?: boolean

      only delete if the queue has no consumers

  Returns Promise<MessageCount>

get

• get(params?: { noAck?: boolean }): Promise<null | AMQPMessage>

  Poll the queue for a single message.

  Parameters

  • Optionalparams: { noAck?: boolean }

    • OptionalnoAck?: boolean

      automatically acknowledge on delivery

  Returns Promise<null | AMQPMessage>

publish

• publish(body: Body, options?: QueuePublishOptions): Promise<AMQPQueue>

  Publish a message directly to this queue (via the default exchange).

  Parameters

  • body: Body
  • options: QueuePublishOptions = {}

  Returns Promise<AMQPQueue>

  this for chaining

purge

• purge(): Promise<MessageCount>

  Purge all messages from this queue.

  Returns Promise<MessageCount>

subscribe

• subscribe(
      callback: (msg: AMQPMessage) => void | Promise<void>,
  ): Promise<AMQPSubscription>

  Subscribe with a callback. Messages are acked after the callback returns, nacked on error.

  Parameters

  • callback: (msg: AMQPMessage) => void | Promise<void>

  Returns Promise<AMQPSubscription>
• subscribe(
      params: QueueSubscribeParams,
      callback: (msg: AMQPMessage) => void | Promise<void>,
  ): Promise<AMQPSubscription>

  Subscribe with a callback and custom params.

  Parameters

  • params: QueueSubscribeParams
  • callback: (msg: AMQPMessage) => void | Promise<void>

  Returns Promise<AMQPSubscription>
• subscribe(params?: QueueSubscribeParams): Promise<AMQPGeneratorSubscription>

  Subscribe via an async iterator. Messages continue yielding across reconnections.

  Parameters

  • Optionalparams: QueueSubscribeParams

  Returns Promise<AMQPGeneratorSubscription>

  Example

  for await (const msg of await q.subscribe()) {
    console.log(msg.bodyString())
    await msg.ack()
  }
  Copy

unbind

• unbind(
      exchange: string,
      routingKey?: string,
      args?: Record<string, unknown>,
  ): Promise<AMQPQueue>

  Remove a binding between this queue and an exchange.

  Parameters

  • exchange: string
  • routingKey: string = ""
  • args: Record<string, unknown> = {}

  Returns Promise<AMQPQueue>

  this for chaining