Interfaces: ApolloMutation

RefetchQueriesType<D> | null

A list of query names which will be refetched once this mutation has returned. This is often used if you have a set of queries which may be affected by a mutation and will have to update. Rather than writing a mutation query reducer (i.e. updateQueries) for this, you can refetch the queries that will be affected and achieve a consistent store once these queries return.

OptimisticResponseType<D, V> | undefined

An object that represents the result of this mutation that will be optimistically stored before the server has actually returned a result.

This is most often used for optimistic UI, where we want to be able to see the result of a mutation immediately, and update the UI later if any errors appear.

ComponentDocument<D> | null

The mutation.

boolean

If true, the returned data property will not update with the mutation result.

boolean

Whether the mutation was called.

boolean | undefined

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.

ApolloClient<NormalizedCacheObject> | null

The Apollo Client instance.

Record<string, unknown> | undefined

Context passed to the link execution chain.

Data<D> | null

Latest mutation data

ComponentDocument<D> | null

Operation document.

GraphQL operation document i.e. query, subscription, or mutation. Must be a parsed GraphQL DocumentNode, so use graphql-tag.

Error | ApolloError | null

Latest error

ErrorPolicy | undefined

Error Policy for the operation.

Much like fetchPolicy, errorPolicy allows you to control how GraphQL errors from the server are sent to your UI code. By default, the error policy treats any GraphQL Errors as network errors and ends the request chain. It doesn't save any data in the cache, and renders your UI with the error property set to an ApolloError. By changing this policy per request, you can adjust how GraphQL Errors are managed by your UI. The possible options for errorPolicy are:

• none (default): any errors from the request are treated like runtime errors and the observable is stopped (XXX this is default to lower breaking changes going from AC 1.0 => 2.0)
• ignore: errors from the request do not stop the observable, but also don't call next
• all: errors are treated like data and will notify observables

readonly GraphQLError[]

Latest errors

string | undefined

Fetch Policy for the operation.

If set to 'no-cache', the mutation result will not update the Apollo cache.

boolean

Whether a request is in flight.

boolean

True when the element is connected and ready to receive its GraphQL document

Variables<D, V> | null

Mutation variables.

An object that maps from the name of a variable as used in the mutation GraphQL document to that variable's value.

A function which updates the apollo cache when the query responds. This function will be called twice over the lifecycle of a mutation. Once at the very beginning if an optimisticResponse was provided. The writes created from the optimistic data will be rolled back before the second time this function is called which is when the mutation has succesfully resolved. At that point update will be called with the actual mutation result and those writes will not be rolled back.

The reason a DataProxy is provided instead of the user calling the methods directly on ApolloClient is that all of the writes are batched together at the end of the update, and it allows for writes generated by optimistic data to be rolled back.

Examples

updater(cache, result) {
  cache.writeQuery({
    query: MyProfileQuery,
    data: { profile: result.data.updateMyProfile },
  });
}

Parameters

Parameters<MutationUpdaterFn<Data<D>, Variables<D, V>>>

ReturnType<MutationUpdaterFn<Data<D>, Variables<D, V>>>

Callback for when an error occurs in mutation.

Parameters

Error

void

Callback for when a mutation is completed.

Parameters

Data<D>

void

This resolves a single mutation according to the options specified and returns a Promise which is either resolved with the resulting data or rejected with an error.

Parameters

Partial<MutationOptions<Data<D>, Variables<D, V>>>

await element.mutate({
  fetchPolicy: 'network-only'
  variables: {
    ...element.variables,
    name: 'overridden',
  },
});

Promise<FetchResult<Data<D>>>