-
Notifications
You must be signed in to change notification settings - Fork 4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Element: Narrow createInterpolateElement
param type.
#49182
Merged
ZebulanStanphill
merged 1 commit into
trunk
from
update/create-interpolate-element-types
Mar 19, 2023
Merged
Element: Narrow createInterpolateElement
param type.
#49182
ZebulanStanphill
merged 1 commit into
trunk
from
update/create-interpolate-element-types
Mar 19, 2023
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
ZebulanStanphill
added
[Type] Code Quality
Issues or PRs that relate to code quality
[Package] Element
/packages/element
labels
Mar 19, 2023
Size Change: 0 B Total Size: 1.34 MB ℹ️ View Unchanged
|
gziolo
approved these changes
Mar 19, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It makes perfect sense. Thank you for bringing it up 👍
gziolo
changed the title
Narrow
Element: Narrow Mar 19, 2023
createInterpolateElement
param type.createInterpolateElement
param type.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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?
This PR simply narrows the type of the
conversionMap
param of thecreateInterpolateElement
function.Why?
The prior type of simply
Object
is pretty vague, allowing clearly nonsense args like{'div': 15.80}
, and by tightening it a bit, IDEs will be able to guide users into using the function correctly as they're writing code.How?
I narrowed the param type to
Record<string, WPElement>
. (In case you're wondering, use of the TypeScript utility typeRecord
in JSDoc works, and the Gutenberg codebase already uses it in existing JSDocs.)Testing Instructions
conversionMap
param ofcreateInterpolateElement
.