Correctly mark vararg parameters in TypescriptDefinition #2239
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
Mark e.g. min as `min(arg1: number, ...arg2: number[])`, otherwise the method cannot be called correctly from Typescript.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2239 +/- ##
=========================================
Coverage 37.43% 37.44%
- Complexity 19837 19841 +4
=========================================
Files 1110 1110
Lines 169562 169570 +8
Branches 35817 35817
=========================================
+ Hits 63483 63492 +9
+ Misses 96012 96011 -1
Partials 10067 10067
... and 1 file with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
That probably makes sense. I would still like to keep this because it is more correct, and we might have some real use case for varargs in the future. |
gausie
approved these changes
Mar 19, 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.
Currently parameters that take a variadic number of arguments are marked as regular array types, e.g.
min(arg1: number, arg2: number[]).That signature only lets you call as
min(1, [2, 3]), which is incorrect and fails.Instead, it should be marked as
min(arg1: number, ...arg2: number[]), otherwise the method cannot be called correctly from Typescript.(I considered introducing an inner Parameter helper class, but that makes the descriptiveParamNames and combatFilterType overrides less convenient to handle. Let me know if I should give it a go.)