docs: fix LazyInfiniteQueryTrigger docs#5261
Open
lilianakatrina684-a11y wants to merge 2 commits into
Open
Conversation
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
1 task
|
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 f4a9b09:
|
aryaemami59
added
Documentation
aryaemami59
changed the title
LazyInfiniteQueryTrigger docs
…o docs-lazy-infinite-query-trigger
✅ Deploy Preview for redux-starter-kit-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
aryaemami59
reviewed
Apr 4, 2026
Comment on lines
+803
to
+807
| * Pass the endpoint argument as the first parameter and either `'forward'` or `'backward'` | ||
| * as the second parameter to fetch the next or previous page from the current cache entry. | ||
| * | ||
| * @remarks | ||
| * If you need to access the error or success payload immediately after a lazy query, you can chain .unwrap(). | ||
| * If you need to access the error or success payload immediately after triggering the request, you can chain `.unwrap()`. |
Member
There was a problem hiding this comment.
Suggested change
| * Pass the endpoint argument as the first parameter and either `'forward'` or `'backward'` | |
| * as the second parameter to fetch the next or previous page from the current cache entry. | |
| * | |
| * @remarks | |
| * If you need to access the error or success payload immediately after a lazy query, you can chain .unwrap(). | |
| * If you need to access the error or success payload immediately after triggering the request, you can chain `.unwrap()`. | |
| * @param arg - The query argument identifying the infinite query cache entry. | |
| * @param direction - The {@linkcode InfiniteQueryDirection | direction} to fetch: **`'forward'`** fetches the next page, and **`'backward'`** fetches the previous page. | |
| * @returns A {@linkcode InfiniteQueryActionCreatorResult | promise-like result object} for the triggered request. Chain {@linkcode InfiniteQueryActionCreatorResult.unwrap | .unwrap()} to access the fulfilled payload or throw the rejected error. |
| > = { | ||
| /** | ||
| * Triggers a lazy query. | ||
| * Triggers an infinite query fetch in the given direction. |
Member
There was a problem hiding this comment.
Suggested change
| * Triggers an infinite query fetch in the given direction. | |
| * Triggers fetching the next or previous page of an infinite query. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
LazyInfiniteQueryTriggerdocs so the second argument is documented as a direction, notpreferCacheValueuseInfiniteQuerySubscriptionsignature to the generated hooks docsCloses #5229