[TypeScript] Improve List exporter type #9968
Merged
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
djhi
reviewed
Jul 1, 2024
| @@ -13,7 +18,8 @@ import { RaRecord, Identifier, DataProvider } from '../types'; | |||
| * ); | |||
| */ | |||
| const fetchRelatedRecords = | |||
There was a problem hiding this comment.
Good time to make it a named export?
djhi
reviewed
Jul 2, 2024
| return jsonExport(commentsWithPostTitle, { | ||
| headers: ['id', 'post_id', 'post_title', 'body'], | ||
| }, (err, csv) => { | ||
| downloadCSV(csv, 'comments'); | ||
| }); | ||
| }; | ||
|
|
||
| const CommentList = () => ( | ||
| <List exporter={exporter}> |
There was a problem hiding this comment.
We can probably go one step further and make exporter typed when passing a type to List:
<List<Comment> exporter={exporter}>
packages/ra-core/src/types.ts
Outdated
| @@ -368,15 +368,17 @@ export interface ResourceProps { | |||
|
|
|||
| export type Exporter = ( | |||
There was a problem hiding this comment.
Exporter should accept a generic type parameter for data
djhi
approved these changes
Jul 2, 2024
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
Writing a custom
<List exporter>by hand is cumbersome, as TypeScript complains a lot.Solution
Avoid
anyin the type definition of thefetchRelatedRecordsfunction parameter.Give an example in the documentation.