useInstanceId: Convert to typescript #43790
Merged
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
walbo
added
[Type] Enhancement
|
Size Change: +28 B (0%) Total Size: 1.25 MB
ℹ️ View Unchanged
|
ciampo
reviewed
Sep 5, 2022
There was a problem hiding this comment.
Great work here!
I've left a few comments re. cleaning the code up, but I've already tested the changes and they seem to work fine 🚀
The compose package also seems to have a CHANGELOG, we should probably add an entry there as well
Comment on lines
+33
to
+39
| function useInstanceId( object: object ): number; | ||
| function useInstanceId( object: object, prefix: string ): string; | ||
| function useInstanceId< T extends string | number >( | ||
| object: object, | ||
| prefix: string, | ||
| preferredId?: T | ||
| ): T; |
There was a problem hiding this comment.
Nice usage of TypeScript overloading!
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.
What?
Refactors
useIntanceIdto TypeScript instead of relying on JSDocs.Why?
When using
useInstanceIdin a typescript file it always returnsstring | number. By refactoruseInstanceIdto typescript we can return a specific type based on what params you pass to the function.How?
Refactored
useIntanceIdto TypeScript.Before
After