Skip to content

Commit e3ce6c6

Browse files
simPodjerelmiller
andauthored
Remove ignoreResults from MutationOptionsDocumentation and MutationResultDocumentation (#12947)
Co-authored-by: Jerel Miller <[email protected]>
1 parent 5b4f36a commit e3ce6c6

File tree

1 file changed

+3
-15
lines changed

1 file changed

+3
-15
lines changed

src/react/types/types.documentation.ts

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -447,25 +447,13 @@ export interface MutationOptionsDocumentation {
447447
* @docGroup 1. Operation options
448448
*/
449449
onError: unknown;
450-
/**
451-
* If `true`:
452-
*
453-
* - The initial state update (setting loading to true) is skipped
454-
* - The success state update (setting data and setting loading to false) is skipped
455-
* - Error updates will still occur
456-
*
457-
* The default value is `false`.
458-
*
459-
* 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.
460-
*
461-
* @docGroup 1. Operation options
462-
*/
463-
ignoreResults: unknown;
464450
}
465451

466452
export interface MutationResultDocumentation {
467453
/**
468-
* The data returned from your mutation. Can be `undefined` if `ignoreResults` is `true`.
454+
* The data returned from your mutation. Can be `undefined` if the `errorPolicy`
455+
* is `all` or `ignore` and the server returns a GraphQL response with `errors`
456+
* but not `data` or a network error is returned.
469457
*/
470458
data: unknown;
471459
/**

0 commit comments

Comments
 (0)