Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds JSDoc/type annotations across the Fastify bearer-auth plugin code to improve editor IntelliSense (autocomplete, parameter hints, and type checking) when working in the JS codebase.
Changes:
- Added JSDoc blocks and
import('../types/index')-based type annotations for the main plugin and auth factory functions. - Documented helper/auth functions (
compare,authenticate,handleUnauthorized) with JSDoc params/returns. - Refactored
lib/compare.jsto importtimingSafeEqualvia destructuring.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| lib/verify-bearer-auth-factory.js | Adds JSDoc/type annotations for the factory and internal helper(s). |
| lib/compare.js | Adds JSDoc for constant-time comparison and refactors crypto import. |
| lib/authenticate.js | Adds JSDoc for key authentication helper. |
| index.js | Adds a top-level JSDoc/type annotation for the exported plugin function. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
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.
Without the tags, VS Code's IntelliSense could not provide autocomplete, parameter hints, or type checking when working in the codebase, which made contributing harder than it needed to be.
This probably also helps other IDEs.
Checklist
npm run test && npm run benchmark --if-presentand the Code of conduct