feat: change optimisticUpdatesFn to getOptimisticState

docs/en/installation.md

@@ -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

docs/en/react/useOptimisticMutation.md

@@ -21,7 +21,7 @@ const {
   mutationFn: addTodo,
   optimisticUpdateOptions: {
     queryKey: ["todos"],
-    optimisticUpdatesFn: ({ prevQueryData, variables }) => {
+    getOptimisticState: ({ prevQueryData, variables }) => {
       return [...prevQueryData, variables];
     },
     invalidateQueryOnSuccess: true
@@ -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

src/react/__tests__/useOptimisticMutation.test.tsx

@@ -36,7 +36,7 @@ describe("useOptimisticMutation", () => {
         mutationFn: () => Promise.resolve(),
         optimisticUpdateOptions: {
           queryKey: MOCK_QUERY_DATA.todo.queryKey,
-          optimisticUpdatesFn: ({ prevQueryData, variables }: { prevQueryData: Todo[]; variables: Todo }) => {
+          getOptimisticState: ({ prevQueryData, variables }: { prevQueryData: Todo[]; variables: Todo }) => {
             return [...prevQueryData, variables];
           }
         }
@@ -68,7 +68,7 @@ describe("useOptimisticMutation", () => {
         mutationFn: () => Promise.reject(),
         optimisticUpdateOptions: {
           queryKey: MOCK_QUERY_DATA.todo.queryKey,
-          optimisticUpdatesFn: ({ prevQueryData, variables }: { prevQueryData: Todo[]; variables: Todo }) => {
+          getOptimisticState: ({ prevQueryData, variables }: { prevQueryData: Todo[]; variables: Todo }) => {
             return [...prevQueryData, variables];
           }
         }
@@ -114,7 +114,7 @@ describe("useOptimisticMutation", () => {
         mutationFn: () => Promise.resolve(),
         optimisticUpdateOptions: {
           queryKey: MOCK_QUERY_DATA.todo.queryKey,
-          optimisticUpdatesFn: ({ prevQueryData, variables }: { prevQueryData: Todo[]; variables: Todo }) => {
+          getOptimisticState: ({ prevQueryData, variables }: { prevQueryData: Todo[]; variables: Todo }) => {
             return [...prevQueryData, variables];
           },
           invalidateQueryOnSuccess: true
@@ -154,7 +154,7 @@ describe("useOptimisticMutation", () => {
         mutationFn: () => Promise.resolve(),
         optimisticUpdateOptions: {
           queryKey: MOCK_QUERY_DATA.todo.queryKey,
-          optimisticUpdatesFn: ({ prevQueryData, variables }: { prevQueryData: Todo[]; variables: Todo }) => {
+          getOptimisticState: ({ prevQueryData, variables }: { prevQueryData: Todo[]; variables: Todo }) => {
             return [...prevQueryData, variables];
           },
           invalidateQueryOnSuccess: () => {
@@ -194,7 +194,7 @@ describe("useOptimisticMutation", () => {
         mutationFn: () => Promise.resolve(),
         optimisticUpdateOptions: {
           queryKey: MOCK_QUERY_DATA.todo.queryKey,
-          optimisticUpdatesFn: updateFnMock
+          getOptimisticState: updateFnMock
         }
       });
 

src/react/useOptimisticMutation/types.ts

@@ -1,20 +1,9 @@
 import { QueryKey } from "@tanstack/react-query";
 
 export type OptimisticUpdateOptions<TQueryData = unknown, TVariables = void> = {
-  /**
-   * A query key for optimistic update
-   */
   queryKey: QueryKey;
-  /**
-   * A function returns the resulting optimistic state.
-   */
-  optimisticUpdatesFn: (param: { prevQueryData: TQueryData; variables: TVariables }) => TQueryData;
-  /**
-   * If set to `true`, the query will fetch if the data is stale.
-   *
-   * @default false
-   */
   invalidateQueryOnSuccess?: boolean | (() => boolean);
+  getOptimisticState: (param: { prevQueryData: TQueryData; variables: TVariables }) => TQueryData;
 };
 
 export type OptimisticUpdateContext = {

src/react/useOptimisticMutation/useOptimisticMutation.ts

@@ -20,7 +20,7 @@ export function useOptimisticMutation<TData = unknown, TError = DefaultError, TV
   const {
     queryKey: optimisticUpdateQueryKey,
     invalidateQueryOnSuccess = false,
-    optimisticUpdatesFn
+    getOptimisticState
   } = optimisticUpdateOptions;
 
   return useMutation<TData, TError, TVariables, OptimisticUpdateContext>(
@@ -35,7 +35,7 @@ export function useOptimisticMutation<TData = unknown, TError = DefaultError, TV
           return;
         }
 
-        const optimisticQueryData = optimisticUpdatesFn({ prevQueryData, variables });
+        const optimisticQueryData = getOptimisticState({ prevQueryData, variables });
 
         client.setQueryData(optimisticUpdateQueryKey, optimisticQueryData);
         onMutate?.(variables);