Skip to content

docs: update changed api #11

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.

Sign up for GitHub

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

Merged
mugglim merged 1 commit into from
Aug 2, 2025
Merged

docs: update changed api #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/en/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ function Page() {
mutationFn: () => Promise.resolve(),
optimisticUpdateOptions: {
queryKey: ["todos"],
optimisticUpdatesFn: ({ prevQueryData, variables }: { prevQueryData: Todo[]; variables: Todo }) => {
getOptimisticState: ({ prevQueryData, variables }: { prevQueryData: Todo[]; variables: Todo }) => {
return [...prevQueryData, variables];
},
invalidateQueryOnSuccess: true
Expand Down
4 changes: 2 additions & 2 deletions docs/en/react/useOptimisticMutation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const {
mutationFn: addTodo,
optimisticUpdateOptions: {
queryKey: ["todos"],
optimisticUpdatesFn: ({ prevQueryData, variables }) => {
getOptimisticState: ({ prevQueryData, variables }) => {
return [...prevQueryData, variables];
},
invalidateQueryOnSuccess: true
Expand All @@ -43,7 +43,7 @@ This parameter extends the original UseMutationOptions. All original options are
- Defaults to `false`
- Whether to invalidate the query after a successful mutation
- If set to `true`, the query will fetch if the data is stale.
- `optimisticUpdatesFn: { prevQueryData: TQueryData; variables: TVariables }) => TQueryData;`
- `getOptimisticState: { prevQueryData: TQueryData; variables: TVariables }) => TQueryData;`
- This function returns the state for optimistic updates.

## queryClient
Expand Down