Skip to content
Merged
Changes from all commits
Commits
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
18 changes: 3 additions & 15 deletions src/react/types/types.documentation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -447,25 +447,13 @@ export interface MutationOptionsDocumentation {
* @docGroup 1. Operation options
*/
onError: unknown;
/**
* If `true`:
*
* - The initial state update (setting loading to true) is skipped
* - The success state update (setting data and setting loading to false) is skipped
* - Error updates will still occur
*
* The default value is `false`.
*
* 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.
*
* @docGroup 1. Operation options
*/
ignoreResults: unknown;
}

export interface MutationResultDocumentation {
/**
* The data returned from your mutation. Can be `undefined` if `ignoreResults` is `true`.
* The data returned from your mutation. Can be `undefined` if the `errorPolicy`
* is `all` or `ignore` and the server returns a GraphQL response with `errors`
* but not `data` or a network error is returned.
*/
data: unknown;
/**
Expand Down