commitMutation

import DocsRating from '@site/src/core/DocsRating'; import {OssOnly, FbInternalOnly} from 'docusaurus-plugin-internaldocs-fb/internal'; import MutationConfig from '../types/MutationConfig.md'; import Disposable from '../types/Disposable.md';

commitMutation

Imperatively execute a mutation.

See also the useMutation API and Guide to Updating Data.

import type {FeedbackLikeMutation} from 'FeedbackLikeMutation.graphql';
const React = require('React');

const {graphql, useMutation} = require('react-relay');

function likeFeedback(environment: IEnvironment): Disposable {
  return commitMutation<FeedbackLikeMutation>(environment, {
    mutation: graphql`
      mutation FeedbackLikeMutation($input: FeedbackLikeData!) {
        feedback_like(data: $input) {
          feedback {
            id
            viewer_does_like
            like_count
          }
        }
      }
    `,
    variables: {
      input: {
        id: '123',
      },
    },
  });
}

Arguments

• environment: IEnvironment. A Relay environment.
• config: MutationConfig<TMutation>.

Flow Type Parameters

• TMutation: Type parameter that should corresponds the Flow type for the mutation query. This type is available to import from the the auto-generated file: <mutationName>.graphql.js.
  • Note that this auto-generated type will implement MutationParameters.

:::caution If you do not explicitly pass this type parameter, the variables, optimistic response and response passed to onCompleted will not be type-checked! :::

Return Value

• A Disposable which:
  • If called while before the request completes, will cancel revert any optimistic updates and prevent the onComplete and onError callbacks from being executed. It will not necessarily cancel any network request. Will cause the onUnsubscribe callback to be called.
  • If called after the initial request completes, will do nothing.