Add new type parameters to functions where possible #3349
Merged
Conversation
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
We're still not verifying the actual object returned by JSON.parse so this isn't any safer at runtime than using 'any', but it helps add more static typing to the code calling readJsonlFile.
robertbrignull
commented
Feb 13, 2024
| * @param telemetry The telemetry listener to use for error reporting. | ||
| */ | ||
| export function registerCommandWithErrorHandling( | ||
| export function registerCommandWithErrorHandling<S extends unknown[], T>( |
Contributor
Author
There was a problem hiding this comment.
It's annoying that registerCommandWithErrorHandling gained two args, but thankfully in all the cases we use it the types are inferred so we don't need to do anything. In reality in both uses the type could be () => void, so I wouldn't be against just hardcoding that here for simplicity, and we can revisit later if this function needs to handle more complex functions.
Contributor
Author
There was a problem hiding this comment.
I've had another go at this and condensed the two type args into one. I don't know why I didn't do this before. Maybe it didn't work before and some other change made it possible, or maybe I just didn't do it properly.
I think this is a better solution overall and makes things clearer.
charisk
approved these changes
Feb 13, 2024
| * @param telemetry The telemetry listener to use for error reporting. | ||
| */ | ||
| export function registerCommandWithErrorHandling( | ||
| export function registerCommandWithErrorHandling<S extends unknown[], T>( |
charisk
approved these changes
Feb 13, 2024
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.
These are a few functions that currently use
anybut could instead have a type parameter.I think each of these cases increases our type safety a little bit. I can't see any downsides, unless I've missed an edge case.
Checklist
ready-for-doc-reviewlabel there.