lit-apollo: ApolloMutation

Looking for reactive Apollo controllers? See @apollo-elements/core

ApolloMutation inherits from ApolloElement and implements the ApolloMutationInterface.

Read the mutation component guides for examples and tips.

ApolloMutation

👩‍🚀 Custom element base class to issue mutations via your Apollo cache.

See ApolloMutationInterface for more information on events

Properties

refetchQueries

refetch-queries

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.

optimisticResponse

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, or a unary function that takes the mutation's variables and returns such an object.

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.

Examples

Using a function

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

mutation

ComponentDocument<D, V> | null

The mutation.

ignoreResults

boolean

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

fetchPolicy

fetch-policy

'no-cache' | undefined

Specifies the FetchPolicy to be used for this mutation.

errorPolicy

error-policy

C.ErrorPolicy | undefined

Specifies the ErrorPolicy to be used for this mutation.

called

boolean

Whether the mutation was called

awaitRefetchQueries

await-refetch-queries

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.