Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add react-apollo awaitRefetchQueries docs #3750

Merged
merged 1 commit into from
Jul 27, 2018
Merged

Add react-apollo awaitRefetchQueries docs #3750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions docs/source/api/react-apollo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1190,7 +1190,11 @@ export default graphql(gql`mutation { ... }`, {
})(MyComponent);
```

Please note that refetched queries are handled asynchronously, and by default are not necessarily completed before the mutation has completed. If you want to make sure refetched queries are completed before the mutation is considered done (or resolved), set [`options.awaitRefetchQueries`](#graphql-mutation-options-awaitRefetchQueries) to `true`.

<h3 id="graphql-mutation-options-awaitRefetchQueries">`options.awaitRefetchQueries`</h3>

Queries refetched using [`options.refetchQueries`](#graphql-mutation-options-refetchQueries) are handled asynchronously, which means by default they are not necessarily completed before the mutation has completed. Setting `options.awaitRefetchQueries` to `true` will make sure refetched queries are completed before the mutation is considered done (or resolved). `options.awaitRefetchQueries` is `false` by default.

<h3 id="graphql-mutation-options-updateQueries">`options.updateQueries`</h3>

Expand Down
2 changes: 2 additions & 0 deletions docs/source/essentials/mutations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,8 @@ The Mutation component accepts the following props. Only `mutation` and `childre
<dd>Provide a [mutation response](../features/optimistic-ui.html) before the result comes back from the server</dd>
<dt>`refetchQueries`: (mutationResult: FetchResult) => Array<{ query: DocumentNode, variables?: TVariables}></dt>
<dd>A function that allows you to specify which queries you want to refetch after a mutation has occurred</dd>
<dt>`awaitRefetchQueries`: boolean</dt>
<dd>Queries refetched as part of `refetchQueries` are handled asynchronously, and are not waited on before the mutation is completed (resolved). Setting this to `true` will make sure refetched queries are completed before the mutation is considered done. `false` by default.</dd>
<dt>`onCompleted`: (data: TData) => void</dt>
<dd>A callback executed once your mutation successfully completes</dd>
<dt>`onError`: (error: ApolloError) => void</dt>
Expand Down