feat(NumberUtils.format): Only return object if returnAria: true #3262
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
The function `format` only returns an object if the option `returnAria` was passed in as `true`, but TypeScript doesn’t know this. With this change, we’re making an overload for the function that only returns the object in the right situation. This way, the caller doesn’t need to check the returned value before being able to use it as a string (or number).
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 76fb120:
|
tujoworker
pushed a commit
that referenced
this pull request
Jan 22, 2024
## [10.19.0](v10.18.0...v10.19.0) (2024-01-22) ### 🐛 Bug Fixes * **Autocomplete:** replace existing aria-live handling with the AriaLive component ([#3258](#3258)) ([0ec06ca](0ec06ca)) * **Breadcrumb:** fix rehydration disturbance ([#3254](#3254)) ([dcf3a8b](dcf3a8b)), closes [#2762](#2762) [#2671](#2671) * **DrawerList:** update original data when data prop changes ([#3247](#3247)) ([d1b03c2](d1b03c2)) * **Field:** show error state without error object if parent FieldBlock has error ([#3225](#3225)) ([35fe238](35fe238)), closes [#2958](#2958) * **Flex.Container:** ensure rowGap=false has effect ([#3242](#3242)) ([e18ddfd](e18ddfd)) * **forms:** rename `contents` to `content` ([#3257](#3257)) ([2c9a397](2c9a397)) * **Input:** should not clear input value with escape key ([#3235](#3235)) ([979b3e3](979b3e3)) * **PhoneNumber:** handle pattern, schema and validator with country code ([#3249](#3249)) ([ed115d5](ed115d5)) * **Table.Accordion:** prevent accordion from opening on label click ([#3228](#3228)) ([ee5014f](ee5014f)) * **Textarea:** correct outline to be inset ([#3237](#3237)) ([6433470](6433470)) ### ✨ Features * **AriaLive:** add new component ([#3217](#3217)) ([7c79a54](7c79a54)) * **Flex:** add `line-framed` to divider ([#3244](#3244)) ([1aa3338](1aa3338)), closes [#3242](#3242) [#3245](#3245) * **forms:** add labelDescription prop to fields (`labelSecondary` got removed) ([#3251](#3251)) ([00c278c](00c278c)), closes [#3209](#3209) [#3252](#3252) * **NumberUtils.format:** Only return object if returnAria: true ([#3262](#3262)) ([ca4315f](ca4315f)) * **Section:** add support for backgroundColor=transparent ([#3255](#3255)) ([07e1545](07e1545)) * **Textarea:** add characterCounter ([#3210](#3210)) ([5c9dde9](5c9dde9)), closes [#3217](#3217) * **TextCounter:** add new fragment used in Textarea ([#3250](#3250)) ([3093c28](3093c28)), closes [#3210](#3210)
|
🎉 This PR is included in version 10.19.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
The function
formatonly returns an object if the optionreturnAriawas passed in astrue, but TypeScript doesn’t know this.With this change, we’re making an overload for the function that only returns the object in the right situation. This way, the caller doesn’t need to check the returned value before being able to use it as a string (or number).
The
formatReturnTypetype is now unused, but given it's been exported I opted to not remove it as that might be considered a breaking change.You can consider this more of a suggestion than a request though, I'm not sure what your policy or testing setup is like for type changes :)