-
Notifications
You must be signed in to change notification settings - Fork 662
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
types: export helper union types #1819
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1819 +/- ##
=======================================
Coverage 81.76% 81.76%
=======================================
Files 35 35
Lines 7742 7742
Branches 316 316
=======================================
Hits 6330 6330
Misses 1400 1400
Partials 12 12
Flags with carried forward coverage won't be shown. Click here to find out more. |
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.
Solid improvements as always! Having exposed types for rich text is super helpful, so thank you for typing this 👏
All of these changes look good to me and the JSDoc is awesome 🚀 📚 No blockers but for my own understanding, are we wanting to export types in this granular way in most cases?
export type SectionBlockAccessory = Button | Checkboxes | Datepicker | ImageElement | MultiSelect | Overflow | | ||
RadioButtons | Select | Timepicker | WorkflowButton; |
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.
Great to see these ordered and matching the docs 🙌
@zimeg Great question; I don't think so, and I would personally default to keeping things internal/non-exported, at least as an initial move, because:
Of course always open to discussing and changing this inclination if the team feels otherwise. |
Summary
This PR fixes #1818. It exports a bunch of helper unions that we use when authoring these types, but that we've heard from the community that they could possibly want to use themselves in their apps (see #1227).