Interface: Consumer<Message, AdditionalProperties>
Defined in: src/consumer/consumer.ts:24
Represents a service consuming messages from RabbitMQ. The generic type Message is the type of the parsed message payload, and AdditionalProperties are extra fields that a consumer implementation can add to the callback arguments.
Extends
EventEmitter<ConsumerEventMap>
Type Parameters
| Type Parameter | Default type |
|---|---|
Message | - |
AdditionalProperties | Record<string, unknown> |
Accessors
channel
Get Signature
get channel():
Channel
Defined in: src/consumer/consumer.ts:45
The channel used by this consumer.
Returns
queue
Get Signature
get queue():
Queue
Defined in: src/consumer/consumer.ts:40
The queue this consumer reads from.
Returns
Methods
close()
close(
timeout?):Promise<void>
Defined in: src/consumer/consumer.ts:29
Stops consuming new messages and waits for all in-flight message handlers to finish.
Parameters
| Parameter | Type | Description |
|---|---|---|
timeout? | number | Maximum time in milliseconds to wait for in-flight messages to complete. Defaults to 30000. |
Returns
Promise<void>
listen()
listen(
callback):Promise<Consumer<Message,AdditionalProperties>>
Defined in: src/consumer/consumer.ts:35
Registers the message handler and starts consuming from the queue.
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | ConsumerCallbackFn<Message, AdditionalProperties> | Handler invoked for each received message. |
Returns
Promise<Consumer<Message, AdditionalProperties>>