Conversation
Copilot
AI
changed the title
[WIP] Sonarlint throwing a TypeError warning for AMQPConsumer / q.subscribe using example on README
Fix TypeScript callback type for AMQPConsumer subscribe method to support async callbacks
Sep 9, 2025
Co-authored-by: baelter <1399369+baelter@users.noreply.github.com>
aae210f to
ca5b1db
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The TypeScript type definitions for the
subscribecallback were too restrictive, only allowing synchronous callbacks that returnvoid. This caused SonarLint to throw warnings when using async callbacks as shown in the README example:The warning was:
However, the runtime already supports async callbacks - this was confirmed by existing tests that use async callbacks successfully. The issue was purely in the TypeScript type definitions being overly restrictive.
This PR updates the callback type signature from
(msg: AMQPMessage) => voidto(msg: AMQPMessage) => void | Promise<void>in:src/amqp-queue.ts-subscribemethodsrc/amqp-channel.ts-basicConsumemethodsrc/amqp-consumer.ts- constructor andonMessagepropertyThe change is minimal and surgical, only updating type signatures to match the actual runtime behavior. No functional code changes were required. This maintains full backward compatibility with existing synchronous callbacks while properly supporting asynchronous ones.
After this change, the README example and any other code using async callbacks in subscribe methods will compile without TypeScript/SonarLint warnings.
Fixes #92.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.