Fix TypeScript callback types to support async callbacks

Copilot · baelter · baelter · commit 6bb132536b5b · 2025-09-09T14:13:54.000+02:00
Co-authored-by: baelter &lt;1399369+baelter@users.noreply.github.com&gt;
diff --git a/src/amqp-channel.ts b/src/amqp-channel.ts
@@ -134,9 +134,9 @@ export class AMQPChannel {
    * @param [param.noAck=true] - if messages are removed from the server upon delivery, or have to be acknowledged
    * @param [param.exclusive=false] - if this can be the only consumer of the queue, will return an Error if there are other consumers to the queue already
    * @param [param.args={}] - custom arguments
-   * @param {function(AMQPMessage) : void} callback - will be called for each message delivered to this consumer
+   * @param {function(AMQPMessage) : void | Promise<void>} callback - will be called for each message delivered to this consumer
    */
-  basicConsume(queue: string, {tag = "", noAck = true, exclusive = false, args = {}} = {}, callback: (msg: AMQPMessage) => void): Promise<AMQPConsumer> {
+  basicConsume(queue: string, {tag = "", noAck = true, exclusive = false, args = {}} = {}, callback: (msg: AMQPMessage) => void | Promise<void>): Promise<AMQPConsumer> {
     if (this.closed) return this.rejectClosed()
     let j = 0
     const noWait = false
diff --git a/src/amqp-consumer.ts b/src/amqp-consumer.ts
@@ -8,7 +8,7 @@ import type { AMQPMessage } from './amqp-message.js'
 export class AMQPConsumer {
   readonly channel: AMQPChannel
   readonly tag: string
-  readonly onMessage: (msg: AMQPMessage) => void
+  readonly onMessage: (msg: AMQPMessage) => void | Promise<void>
   private closed = false
   private closedError?: Error
   private resolveWait?: (value: void) => void
@@ -20,7 +20,7 @@ export class AMQPConsumer {
    * @param tag - consumer tag
    * @param onMessage - callback executed when a message arrive
    */
-  constructor(channel: AMQPChannel, tag: string, onMessage: (msg: AMQPMessage) => void) {
+  constructor(channel: AMQPChannel, tag: string, onMessage: (msg: AMQPMessage) => void | Promise<void>) {
     this.channel = channel
     this.tag = tag
     this.onMessage = onMessage
diff --git a/src/amqp-queue.ts b/src/amqp-queue.ts
@@ -61,10 +61,10 @@ export class AMQPQueue {
    * @param [params.exclusive=false] - if this can be the only consumer of the queue, will return an Error if there are other consumers to the queue already
    * @param [params.tag=""] - tag of the consumer, will be server generated if left empty
    * @param [params.args={}] - custom arguments
-   * @param {function(AMQPMessage) : void} callback - Function to be called for each received message
+   * @param {function(AMQPMessage) : void | Promise<void>} callback - Function to be called for each received message
    */
   subscribe({ noAck = true, exclusive = false, tag = "", args = {} }: ConsumeParams = {},
-    callback: (msg: AMQPMessage) => void): Promise<AMQPConsumer> {
+    callback: (msg: AMQPMessage) => void | Promise<void>): Promise<AMQPConsumer> {
     return this.channel.basicConsume(this.name, { noAck, exclusive, tag, args }, callback)
   }
 
