Class AMQPGeneratorConsumer

A consumer, subscribed to a queue

Hierarchy (View Summary)

AMQPConsumer
- AMQPGeneratorConsumer

Index

Constructors

Properties

channel closed closedError? onMessage tag

Accessors

Methods

Constructors

constructor

new AMQPGeneratorConsumer(
channel: AMQPChannel,
tag: string,
): AMQPGeneratorConsumer
Parameters
- channel: AMQPChannel
- tag: string
Returns AMQPGeneratorConsumer
Overrides AMQPConsumer.constructor
- Defined in src/amqp-consumer.ts:86

Properties

`Readonly`channel

channel: AMQPChannel

Channel this consumer is attached to.

`Protected`closed

closed: boolean = false

`Protected` `Optional`closedError

closedError?: Error

`Readonly`onMessage

onMessage: (msg: AMQPMessage) => void | Promise<void>

Callback invoked for each delivered message.

`Readonly`tag

tag: string

Server-assigned consumer tag.

Accessors

messages

get messages(): AsyncGenerator<AMQPMessage, void, undefined>
Get an AsyncGenerator for consuming messages.

Returns AsyncGenerator<AMQPMessage, void, undefined>
An AsyncGenerator that yields messages
- Defined in src/amqp-consumer.ts:102

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. Safe to call multiple times — concurrent calls share the same underlying wire operation.

Returns Promise<AMQPChannel>
Inherited from AMQPConsumer.cancel
- Defined in src/amqp-consumer.ts:55

wait

wait(timeout?: number): Promise<void>
Wait for the consumer to finish.
Parameters
- Optionaltimeout: 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.
Inherited from AMQPConsumer.wait
- Defined in src/amqp-consumer.ts:37