Skip to main content

graphQLMutationEffect()

The underlying atom effect for causing a local update to an atom to iniate commiting a GraphQL mutation to the server.

Note that if an atom has multiple atom effects which update its value then the other effects may cause graphQLMutationEffect() to initiate a server mutation. So, care should be taken if trying to combine with graphQLQueryEffect(). If that is desired it may be easier to use graphQLSelector() instead.

function graphQLMutationEffect<
  TVariables: Variables,
  T,
  TResponse: $ReadOnly<{[string]: mixed}> = {},
  TRawResponse = void,
>({
  environment: IEnvironment | EnvironmentKey,
  mutation: Mutation<TVariables, TResponse, TRawResponse>,
  variables: T => TVariables | null,

  updater_UNSTABLE?: SelectorStoreUpdater<TResponse>,
  optimisticUpdater_UNSTABLE?: SelectorStoreUpdater<TResponse>,
  optimisticResponse_UNSTABLE?: T => TResponse,
  uploadables_UNSTABLE?: UploadableMap,
}): AtomEffect<T>
  • environment: The Relay Environment or an EnvironmentKey to match with the environment provided with <RecoilRelayEnvironemnt>.
  • mutation: The GraphQL mutation.
  • variables: Callback provided the new atom value that returns the variables object provided as input to the GraphQL mutation. If it returns null then the mutation is skipped.

Optional options:

  • updater_UNSTABLE: Optional updater() function passed to commitMutation().
  • optimisticUpdater_UNSTABLE: Optional optimisticUpdater() function passed to commitMutation().
  • optimisticResponse_UNSTABLE: Optional optimistic response passed to commitMutation().
  • uploadables_UNSTABLE: Optional uploadables passed to commitMutation().