Skip to content

Commit 1e0d47d

Browse files
naman1608Naman Dhingra
and
Naman Dhingra
authored
clarification for mutationHookOptions.ignoreResults in the docs (#12132)
Co-authored-by: Naman Dhingra <[email protected]>
1 parent 9d6c306 commit 1e0d47d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/react/types/types.documentation.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -465,10 +465,16 @@ export interface MutationOptionsDocumentation {
465465
*/
466466
onError: unknown;
467467
/**
468-
* If `true`, the mutation's `data` property is not updated with the mutation's result.
468+
* If `true`:
469+
*
470+
* - The initial state update (setting loading to true) is skipped
471+
* - The success state update (setting data and setting loading to false) is skipped
472+
* - Error updates will still occur
469473
*
470474
* The default value is `false`.
471475
*
476+
* This option is useful when you want to execute a mutation but don't need to track its progress or result in the UI, potentially improving performance by reducing re-renders.
477+
*
472478
* @docGroup 1. Operation options
473479
*/
474480
ignoreResults: unknown;

0 commit comments

Comments
 (0)