fix(types): avoid inferring UiState type from initialUiState #5061
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
This allows someone with custom widgets to still use setUiState etc. without type errors
if you pass initialUiState, that should be asserted by the generic UiState, not automatically accepted. Otherwise you get use cases like the "with function form sets indices state" test where setUiState thinks query is required, just because it has the default given The way this works is by using `NoInfer` from microsoft/TypeScript#14829 (comment) which seems to be quite relied upon This is a follow-up on #5060
|
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 d51c3ac:
|
| // this purposely breaks typescript's type inference to ensure it's not used | ||
| // as it's used for a default parameter for example | ||
| // source: https://github.com/Microsoft/TypeScript/issues/14829#issuecomment-504042546 | ||
| type NoInfer<T> = [T][T extends any ? 0 : never]; |
There was a problem hiding this comment.
Did you see this simplified version microsoft/TypeScript#14829 (comment) ?
There was a problem hiding this comment.
I tried that last one too, but it made lots of items in the codebase report errors. Not really sure what the difference is though, unfortunately
|
I measured it by looking at the 20/30 PR references in that typescript issue, which used this method, but also the others in the thread that don't work for this specific use case |
francoischalifour
approved these changes
Jun 8, 2022
FabienMotte
approved these changes
Jun 9, 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.
Summary
if you pass initialUiState, that should be asserted by the generic UiState, not automatically accepted. Otherwise you get use cases like the "with function form sets indices state" test where setUiState thinks query is required, just because it has the default given
The way this works is by using
NoInferfrom microsoft/TypeScript#14829 (comment) which seems to be quite relied upon. See also https://stackoverflow.com/a/56688073/3185307This is a follow-up on #5060
Result
ui state is not inferred from initialUiState, but rather enforced by it. This means however that custom widgets are no longer "automatically detected from initialUiState", which I don't think is a breaking change, as it's only a type change