[TypeScript] Fix useGetOne and useGetMany params type when id param is undefined #9971
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
… false
## Problem
TypeScript complains when `useGetOne` is called with an undefined `id`. This is fine, except when using the `enabled` option:
```jsx
const { data, error, isPending } = useGetOne<Post>(
'posts',
{ id: comment?.post_id },
{ enabled: !!comment }
);
```
## Solution
Use type overloads to allow optional id when enabled is specified.
|
Now I wonder if that's the right fix. Instead of forcing users to set the enabled flag when the main param may be undefined, shouldn't we relax the params type to accept undefined values, and set the enabled flag ourselves if the main param is undefined? |
I like this idea 👍 |
fzaninotto
changed the title
djhi
reviewed
Jul 4, 2024
Comment on lines
+302
to
+335
| describe('TypeScript', () => { | ||
| it('should return the parametric type', () => { | ||
| type Foo = { id: number; name: string }; | ||
| const _Dummy = () => { | ||
| const { data, error, isPending } = useGetOne<Foo>('posts', { | ||
| id: 1, | ||
| }); | ||
| if (isPending || error) return null; | ||
| return <div>{data.name}</div>; | ||
| }; | ||
| // no render needed, only checking types | ||
| }); | ||
| it('should accept empty id param', () => { | ||
| const _Dummy = () => { | ||
| type Comment = { | ||
| id: number; | ||
| post_id: number; | ||
| }; | ||
| const { data: comment } = useGetOne<Comment>('comments', { | ||
| id: 1, | ||
| }); | ||
| type Post = { | ||
| id: number; | ||
| title: string; | ||
| }; | ||
| const { data, error, isPending } = useGetOne<Post>('posts', { | ||
| id: comment?.post_id, | ||
| }); | ||
| if (isPending || error) return null; | ||
| return <div>{data.title}</div>; | ||
| }; | ||
| // no render needed, only checking types | ||
| }); | ||
| }); |
There was a problem hiding this comment.
Unfortunately, as we don't compile our tests, we won't ever see this fail in CI
djhi
reviewed
Jul 4, 2024
| @@ -398,4 +398,45 @@ describe('useGetMany', () => { | |||
| expect(abort).toHaveBeenCalled(); | |||
| }); | |||
| }); | |||
|
|
|||
| describe('TypeScript', () => { | |||
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.
Problem
TypeScript complains when
useGetOneis called with an undefinedid. This is fine, except when using theenabledoption:This is a consequence of the strictNullCheck flag in ra-core.
Solutions
We choose solution 2.