Class AMQPConsumer

A consumer, subscribed to a queue

Hierarchy

AMQPConsumer

Index

Constructors

Properties

channel closed closedError? onMessage rejectWait? resolveWait? tag timeoutId?

Methods

Constructors

constructor

new AMQPConsumer(channel, tag, onMessage): AMQPConsumer
Parameters
- channel: AMQPChannel
  
  the consumer is created on
- tag: string
  
  consumer tag
- onMessage: ((msg) => void)
  
  callback executed when a message arrive
  - - (msg): void
    - Parameters
      
      msg: AMQPMessage
      
      Returns void
Returns AMQPConsumer
- Defined in src/amqp-consumer.ts:23

Properties

`Readonly` channel

channel: AMQPChannel

`Private` closed

closed: boolean = false

`Private` `Optional` closedError

closedError?: Error

`Readonly` onMessage

onMessage: ((msg) => void)

Type declaration

- (msg): void
- Parameters
  - msg: AMQPMessage
  Returns void

`Private` `Optional` rejectWait

rejectWait?: ((err) => void)

Type declaration

- (err): void
- Parameters
  - err: Error
  Returns void

`Private` `Optional` resolveWait

resolveWait?: ((value) => void)

Type declaration

- (value): void
- Parameters
  - value: void
  Returns void

`Readonly` tag

tag: string

`Private` `Optional` timeoutId

timeoutId?: Timeout

Methods

cancel

cancel(): Promise<AMQPChannel>
Cancel/abort/stop the consumer. No more messages will be deliviered to the consumer. Note that any unacked messages are still unacked as they belong to the channel and not the consumer.

Returns Promise<AMQPChannel>
- Defined in src/amqp-consumer.ts:51

wait

wait(timeout?): Promise<void>
Wait for the consumer to finish.
Parameters
- Optional timeout: number
  
  wait for this many milliseconds and then return regardless
Returns Promise<void>
Fulfilled when the consumer/channel/connection is closed by the client. Rejected if the timeout is hit.
- Defined in src/amqp-consumer.ts:34

Generated using TypeDoc