refactor(sdk-base)!: Use TypeScript overload signature for addEvent
#5359
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
chancancode
force-pushed
the
typescript-overload-signatures
branch
from
df1f61c to
3198cfb
Compare
This makes the intent more clear, and makes the invalid signature `addEvent(name, timeStamp1, timeStamp2)` explicitly illegal in TS. This has always been the intent, and the textual documentation somewhat implies that already. Technically, this is breaking change for TypeScript users. There are situations previously valid TS code will stop being accepted by the type checker, even if the code is semantically valid. It mostly arises when the caller is trying to propagate the same-ish overload signature. It can still be done safely, just requires a bit more care. In any case, this will go into the 2.0 release so it's a great time to make this change.
chancancode
force-pushed
the
typescript-overload-signatures
branch
from
3198cfb to
4f7c300
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5359 +/- ##
=======================================
Coverage 94.54% 94.54%
=======================================
Files 318 318
Lines 8051 8051
Branches 1694 1694
=======================================
Hits 7612 7612
Misses 439 439
|
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.
Which problem is this PR solving?
Stumbled upon this #5333. If it creates conflicts I'm perfectly happy with @brianphillips absorbing these into there.
This makes the intent more clear, and makes the invalid signature
addEvent(name, timeStamp1, timeStamp2)explicitly illegal in TS.This has always been the intent, and the textual documentation somewhat implies that already.
Technically, this is breaking change for TypeScript users. There are situations previously valid TS code will stop being accepted by the type checker, even if the code is semantically valid. It mostly arises when the caller is trying to propagate the same-ish overload signature. It can still be done safely, just requires a bit more care.
In any case, this will go into the 2.0 release so it's a great time to make this change.
That being said, the change/breakage may be too in the weeds to warrant a CHANGELOG entry? Not sure.
Short description of the changes
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Checklist: