[Fix] Change type of unused req param to unknown to resolve type conflicts#394
Merged
evansims merged 3 commits intoauth0:masterfrom Jun 25, 2024
Merged
[Fix] Change type of unused req param to unknown to resolve type conflicts#394evansims merged 3 commits intoauth0:masterfrom
evansims merged 3 commits intoauth0:masterfrom
Conversation
|
@evansims could we please get this merged? |
evansims
approved these changes
Jun 25, 2024
Merged
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.
Description
This PR resolves #393 by relaxing the type requirements around the
reqparameter in the callbacks returned by both theexpressJwtSecretandpassportJwtSecretintegrations. This parameter is not used by the implementations of either function, so it can be safely relaxed to anunknowntype. This would allow any value to be inputted, maintaining both backwards and forwards compatibility with type changes in the related express and passport libraries.The alternative proposed in the issue would be to resolve this new conflict by updating the type to stay precisely in step with passport, but that would introduce unnecessary backwards-compatibility problems for people who were on earlier versions of
@types/passport. Since this type's only purpose is to maintain conformance with the external library's types, going with the most permissive solution seems best.References
Testing
This change is only to make the typescript typing more permissive, and so I believe no change to the testing plan is required.
Checklist