basalt / queue-rabbitmq/src / AmqpChannel
Interface: AmqpChannel
Defined in: queue-rabbitmq/src/index.ts:10
The subset of an amqplib channel this driver uses.
Methods
ack()
> ack(message): void
Defined in: queue-rabbitmq/src/index.ts:24
Parameters
message
Returns
void
assertQueue()
> assertQueue(queue, options?): Promise<unknown>
Defined in: queue-rabbitmq/src/index.ts:17
Parameters
queue
string
options?
Record<string, unknown>
Returns
Promise<unknown>
close()
> close(): Promise<void>
Defined in: queue-rabbitmq/src/index.ts:32
Returns
Promise<void>
consume()
> consume(queue, onMessage, options?): Promise<unknown>
Defined in: queue-rabbitmq/src/index.ts:19
Parameters
queue
string
onMessage
(msg) => void
options?
Record<string, unknown>
Returns
Promise<unknown>
on()?
> optional on(event, listener): void
Defined in: queue-rabbitmq/src/index.ts:16
amqplib channels are EventEmitters; optional so test fakes stay tiny. 'close' is what drives reconnection — without it a lost channel is permanent.
Parameters
event
"error" | "close"
listener
(error?) => void
Returns
void
prefetch()
> prefetch(count): void | Promise<unknown>
Defined in: queue-rabbitmq/src/index.ts:25
Parameters
count
number
Returns
void | Promise<unknown>
sendToQueue()
> sendToQueue(queue, content, options?): boolean
Defined in: queue-rabbitmq/src/index.ts:18
Parameters
queue
string
content
Uint8Array
options?
Record<string, unknown>
Returns
boolean
waitForConfirms()?
> optional waitForConfirms(): Promise<void>
Defined in: queue-rabbitmq/src/index.ts:31
Confirm channels only (amqplib createConfirmChannel): resolves when the broker has confirmed every outstanding publish. The driver awaits this before acking, closing the publish-lost/ack-done job-loss window.
Returns
Promise<void>