Interfaces: ApolloMutation

boolean

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.

boolean

Whether the mutation was called

Extract<FetchPolicy, 'no-cache'>

Specifies the FetchPolicy to be used for this mutation.

boolean

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

DocumentNode | TypedDocumentNode

A GraphQL document containing a single mutation. You can set it as a JavaScript property or by appending a GraphQL script to the element (light DOM).

<script type="application/graphql">
  mutation { updateLastSeen }
</script>

Data<D> | ((vars: Variables<D, V>) => Data<D>)

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.

element.optimisticResponse = ({ name }: HelloMutationVariables) => ({
  __typename: 'Mutation',
  hello: {
    __typename: 'Greeting',
    name,
  },
});

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.

ApolloClient<NormalizedCacheObject> | null

The Apollo Client instance

Defaults to window.__APOLLO_CLIENT__, which is set by default when creating an Apollo Client. That means that in most cases, it's not necessary to explicity set the client property. For more information see Getting Started: Apollo Client.

Record<string, unknown>

Context passed to the link execution chain.

Data<D> | null

Latest mutation data.

DocumentNode | TypedDocumentNode | null

A GraphQL document containing a single query, mutation, or subscription. You can set it as a JavaScript property or by appending a GraphQL script to the element (light DOM).

'mutation'

Hint that this is a mutation component

Error | ApolloError | null

Latest error

ErrorPolicy

Specifies the Error Policy to be used for this mutation.

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: This is the default policy to match how Apollo Client 1.0 worked. Any GraphQL Errors are treated the same as network errors and any data is ignored from the response.
• ignore: Ignore allows you to read any data that is returned alongside GraphQL Errors, but doesn't save the errors or report them to your UI.
• all: Using the all policy is the best way to notify your users of potential issues while still showing as much data as possible from your server. It saves both data and errors so your UI can use them.

readonly GraphQLError[] | null

Latest errors.

boolean

Whether a request is in-flight.

Variables<D, V> | null

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

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',
  },
});

boolean

Record<string, unknown>

ErrorPolicy

FetchPolicy

DocumentNode | TypedDocumentNode

OptimisticResponseType<D, V>

RefetchQueriesType<D>

MutationUpdaterFn<Data<D>> 

Variables<D, V> 

Promise<FetchResult<Data<D>>>

Data<D>

readonly GraphQLError[]

boolean

Record<string, unknown>

Callback for when a mutation is completed.

Parameters

Data<D>

void

Callback for when an error occurs in mutation.

Parameters

Error

void

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.

Note that since this function is intended to be used to update the store, it cannot be used with a no-cache fetch policy. If you're interested in performing some action after a mutation has completed, and you don't need to update the store, use the Promise returned from client.mutate instead.

Parameters

ApolloCache

FetchResult<Data<D>>

Data<D>

readonly GraphQLError[]

boolean

Record<string, unknown>

void

Lifecycle callback that reacts to changes in the GraphQL document.

Parameters

DocumentNode | TypedDocumentNode | null

void

Lifecycle callback that reacts to changes in the operation variables.

Parameters

Variables<D, V> | null

void