-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
docs: fix LazyInfiniteQueryTrigger docs
#5261
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
lilianakatrina684-a11y
wants to merge
2
commits into
reduxjs:master
Choose a base branch
from
lilianakatrina684-a11y:docs-lazy-infinite-query-trigger
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+42
−5
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -798,19 +798,19 @@ export type LazyInfiniteQueryTrigger< | |||||||||||||||||||
| D extends InfiniteQueryDefinition<any, any, any, any, any>, | ||||||||||||||||||||
| > = { | ||||||||||||||||||||
| /** | ||||||||||||||||||||
| * Triggers a lazy query. | ||||||||||||||||||||
| * Triggers an infinite query fetch in the given direction. | ||||||||||||||||||||
| * | ||||||||||||||||||||
| * By default, this will start a new request even if there is already a value in the cache. | ||||||||||||||||||||
| * If you want to use the cache value and only start a request if there is no cache value, set the second argument to `true`. | ||||||||||||||||||||
| * 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()`. | ||||||||||||||||||||
|
Comment on lines
+803
to
+807
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||
| * | ||||||||||||||||||||
| * @example | ||||||||||||||||||||
| * ```ts | ||||||||||||||||||||
| * // codeblock-meta title="Using .unwrap with async await" | ||||||||||||||||||||
| * try { | ||||||||||||||||||||
| * const payload = await getUserById(1).unwrap(); | ||||||||||||||||||||
| * const payload = await triggerPosts('fire', 'forward').unwrap(); | ||||||||||||||||||||
| * console.log('fulfilled', payload); | ||||||||||||||||||||
| * } catch (error) { | ||||||||||||||||||||
| * console.error('rejected', error); | ||||||||||||||||||||
|
|
||||||||||||||||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.