[API Concept] - Infinite Query API #4393
Draft
+1,517
−113
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.
This is a conceptual display of an API and how it would work inside RTKQ for an infinite Query. This is not a final implementation.
It is derived from the API for react query Infinite Query but with RTKQ's useInfiniteQuery hook etc and implementation.
disclaimer:
The typing and actual code for a library and implementation is bad, it basically just takes and repeats 90% of the query hook logic, the final implementation would more likely be an extension of the Query definition, but I wanted to completely separate it to make it more clear for feedback on the API.
Summary
useInfiniteQuery
hook - works almost the same asuseQuery
New args:
getNextPage
getPreviousPage
New Returns:
fetchNextPage
trigger function, similar to a lazyQuery trigger but combined with the querySubscriptionfetchPreviousPage
hasNextPage
- I haven't implemented it yet :DhasPrevPage
- I haven't implemented it yet :DisFetchingNextPage
isFetchingPrevPage
InfiniteQuery
is a new EndpointDefinitionUses its own initiator, and then initiates a typical
QueryThunk
Additional logic added to
querySlice
that adds direction/param to the querySubState and acts as the discriminator for an InfiniteQuery (different to arg which acts as the set cache key)ExecuteEndpoint
is changed to fetch every page from the pageParams that hasn't been fetched yet and add to the data object in the direction specified.Still needs to be done:
hasPrevPage
&hasNextPage
stateOpen Questions