fix: correct JSDoc parameter type in Authenticator.prototype.use#1053
Open
AkaHarshit wants to merge 1 commit intojaredhanson:masterfrom
Open
fix: correct JSDoc parameter type in Authenticator.prototype.use#1053AkaHarshit wants to merge 1 commit intojaredhanson:masterfrom
AkaHarshit wants to merge 1 commit intojaredhanson:masterfrom
Conversation
Improve type inference by allowing undefined strategy. Fixes: jaredhanson#896
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
1 participant
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.
Problem
Authenticator.prototype.usehas an incorrect JSDoc parameter type forstrategy. This causes editors that support type inference from JSDoc to fail parsing function calls properly when the second argument is not provided.Solution
Updated the JSDoc parameter type from
@param {Strategy} strategyto@param {Strategy|undefined} strategyto correctly reflect the implementation which allowsstrategyas the first argument.Testing
Passed the existing
npm testsuite to avoid any regressions since this is a documentation comment change.Linked Issue
Fixes: #896