Fix: allow TValue to be specified in display and group column helpers #5667
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
Normally, this is not an issue, since ColumnDef is contravariant with respect to TValue. However, the user might extend BaseColumnDef or another constituent of ColumnDef such that ColumnDef becomes invariant with respect to TValue. In that case, DisplayColumnDef<TData, unknown> is no longer assignable to ColumnDef<TData, TValue>. By adding TValue as a generic argument to display and group helpers, Typescript can infer the required type of TValue.
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 3eb37bd. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 2 targetsSent with 💌 from NxCloud. |
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.
By default, the return types of
columnHelper.displayandcolumnHelper.groupare fine, becauseColumnDef<TData, TValue>is contravariant with respect toTValue. However, the user might extendColumnDefBase(or another type constituent ofColumnDef) via declaration merging, such that this no longer holds. At that point, the helper can no longer be used because its return type is no longer assignable toColumnDef. Adding the type argument todisplayandgroupfixes this issue.