Components: Fix TS types for isValueDefined()/isValueEmpty()
#43983
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
mirka
added
[Type] Code Quality
mirka
commented
Sep 8, 2022
| * @param {number} min The minimum range. | ||
| * @param {number} max The maximum range. | ||
| * @param {number} step A multiplier for the value. | ||
| * @param {number | string} value The value. |
There was a problem hiding this comment.
This function can safely accept string number values because they get casted to number.
|
Size Change: +88 B (0%) Total Size: 1.25 MB
ℹ️ View Unchanged
|
ciampo
approved these changes
Sep 8, 2022
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.
Follow-up to #43791 (comment)
What?
Fixes the TypeScript types for the
isValueDefined()/isValueEmpty()utility functions so it can properly narrow down execution paths.Why?
When typed properly, TypeScript should be able to tell that
nextValuewill always be never beundefined:https://github.com/WordPress/gutenberg/blob/e3336723f09e90842507f4929fe40e40a02cbc3d/packages/components/src/number-control/index.tsx#L88-L90
The existing types were failing to do this.
How?
Fixes up the type predicates so they are a bit more explicit.
Testing Instructions
✅ Type checks pass