Class AMQPQueue

constructor

• new AMQPQueue(channel: AMQPChannel, name: string): AMQPQueue

  Parameters

  • channel: AMQPChannel

    channel this queue was declared on
  • name: string

    name of the queue

  Returns AMQPQueue

Readonlychannel

Readonlyname

bind

• bind(exchange: string, routingKey?: string, args?: {}): Promise<AMQPQueue>

  Bind the queue to an exchange

  Parameters

  • exchange: string
  • routingKey: string = ""
  • args: {} = {}

  Returns Promise<AMQPQueue>

delete

• delete(): Promise<AMQPQueue>

  Delete the queue

  Returns Promise<AMQPQueue>

get

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

  Poll the queue for messages

  Parameters

  • params: { noAck?: boolean } = {}

    • OptionalnoAck?: boolean

      automatically acknowledge messages when received

  Returns Promise<null | AMQPMessage>

publish

• publish(
      body:
          | null
          | string
          | ArrayBuffer
          | Uint8Array<ArrayBufferLike>
          | Buffer<ArrayBufferLike>,
      properties?: AMQPProperties,
  ): Promise<AMQPQueue>

  Publish a message directly to the queue

  Parameters

  • body:
        | null
        | string
        | ArrayBuffer
        | Uint8Array<ArrayBufferLike>
        | Buffer<ArrayBufferLike>

    the data to be published, can be a string or an uint8array
  • properties: AMQPProperties = {}

    publish properties

  Returns Promise<AMQPQueue>

  fulfilled when the message is enqueue on the socket, or if publish confirm is enabled when the message is confirmed by the server

purge

• purge(): Promise<MessageCount>

  Returns Promise<MessageCount>

subscribe

• subscribe(
      params: ConsumeParams,
      callback: (msg: AMQPMessage) => void | Promise<void>,
  ): Promise<AMQPConsumer>

  Subscribe to the queue

  Parameters

  • params: ConsumeParams

    • Optionalargs?: Record<string, any>

      custom arguments

    • Optionalexclusive?: boolean

      if this can be the only consumer of the queue, will return an Error if there are other consumers to the queue already

    • OptionalnoAck?: boolean

      if messages are removed from the server upon delivery, or have to be acknowledged

    • Optionaltag?: string

      tag of the consumer, will be server generated if left empty
  • callback: (msg: AMQPMessage) => void | Promise<void>

    Function to be called for each received message

  Returns Promise<AMQPConsumer>
• subscribe(params: ConsumeParams): Promise<AMQPGeneratorConsumer>

  Subscribe to the queue. Use consumer.messages to iterate over messages with an AsyncGenerator.

  Parameters

  • params: ConsumeParams

    • Optionalargs?: Record<string, any>

      custom arguments

    • Optionalexclusive?: boolean

      if this can be the only consumer of the queue, will return an Error if there are other consumers to the queue already

    • OptionalnoAck?: boolean

      if messages are removed from the server upon delivery, or have to be acknowledged

    • Optionaltag?: string

      tag of the consumer, will be server generated if left empty

  Returns Promise<AMQPGeneratorConsumer>

  • Consumer with an AsyncGenerator for messages at consumer.messages

unbind

• unbind(exchange: string, routingKey?: string, args?: {}): Promise<AMQPQueue>

  Delete a binding between this queue and an exchange

  Parameters

  • exchange: string
  • routingKey: string = ""
  • args: {} = {}

  Returns Promise<AMQPQueue>

unsubscribe

• unsubscribe(consumerTag: string): Promise<AMQPQueue>

  Unsubscribe from the queue

  Parameters

  • consumerTag: string

  Returns Promise<AMQPQueue>