noUnusedParameters: add note about underscore prefix exception #3178
Conversation
This file contains 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
jakebailey
added
the
deploy-preview
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-plant-05c166c10-3178.centralus.5.azurestaticapps.net |
jakebailey
reviewed
Aug 8, 2024
| Parameters declaration with names starting with an underscore _ are exempt from the unused parameter checking. e.g.: | ||
|
|
||
| ```ts twoslash | ||
| function returnNull(_a) { |
There was a problem hiding this comment.
This needs a type annotation to prevent the error: https://victorious-plant-05c166c10-3178.centralus.5.azurestaticapps.net/tsconfig/#noUnusedParameters
There was a problem hiding this comment.
Also, set // @noUnusedParameters here. Best to copy the above example and just rename the parameter, actually (but without the @errors)
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.
In the release notes for noUnusedParameters, there's a note about prefixing the parameter name with an underscore to bypass this error.
This PR adds that same note and example to the noUnusedParameters documentation.
(thanks to @lindboe for noticing this and pointing me to the release docs!)