Add more information about deprecation of useMutation ignoreResults o…

…ption
Cellule · Jan 23, 2025 · 5ccf837 · 5ccf837
1 parent 9849694
commit 5ccf837
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.changeset/khaki-cars-develop.md b/.changeset/khaki-cars-develop.md
@@ -3,3 +3,5 @@
 ---
 
 Deprecate option `ignoreResults` in `useMutation`.
+Once this option is removed, existing code still using it might see increase in re-renders.
+Instead, please use `useApolloClient` to get your ApolloClient instance and call `client.mutate` directly.
diff --git a/src/react/types/types.ts b/src/react/types/types.ts
@@ -360,7 +360,10 @@ export interface BaseMutationOptions<
   onError?: (error: ApolloError, clientOptions?: BaseMutationOptions) => void;
   /**
    * {@inheritDoc @apollo/client!MutationOptionsDocumentation#ignoreResults:member}
-   * @deprecated This property will be removed in the next major version of Apollo Client
+   *
+   * @deprecated This property will be removed in the next major version of Apollo Client.
+   * Once this option is removed, existing code still using it might see increase in re-renders.
+   * Instead, please use `useApolloClient` to get your ApolloClient instance and call `client.mutate` directly.
    */
   ignoreResults?: boolean;
 }