graphql-relay/mutation/mutation.d.ts

A library to help construct a graphql-js server supporting react-relay.

import type {
  GraphQLFieldConfig,
  GraphQLFieldExtensions,
  GraphQLInputFieldConfig,
  GraphQLResolveInfo,
  ThunkObjMap,
} from 'graphql';
declare type MutationFn<TInput = any, TOutput = unknown, TContext = any> = (
  object: TInput,
  ctx: TContext,
  info: GraphQLResolveInfo,
) => TOutput;
/**
 * A description of a mutation consumable by mutationWithClientMutationId
 * to create a GraphQLFieldConfig for that mutation.
 *
 * The inputFields and outputFields should not include `clientMutationId`,
 * as this will be provided automatically.
 *
 * An input object will be created containing the input fields, and an
 * object will be created containing the output fields.
 *
 * mutateAndGetPayload will receive an Object with a key for each
 * input field, and it should return an Object with a key for each
 * output field. It may return synchronously, or return a Promise.
 */
interface MutationConfig<TInput = any, TOutput = unknown, TContext = any> {
  name: string;
  description?: string;
  deprecationReason?: string;
  extensions?: GraphQLFieldExtensions<any, any>;
  inputFields: ThunkObjMap<GraphQLInputFieldConfig>;
  outputFields: ThunkObjMap<GraphQLFieldConfig<TOutput, TContext>>;
  mutateAndGetPayload: MutationFn<TInput, Promise<TOutput> | TOutput, TContext>;
}
/**
 * Returns a GraphQLFieldConfig for the mutation described by the
 * provided MutationConfig.
 */
export declare function mutationWithClientMutationId<
  TInput = any,
  TOutput = unknown,
  TContext = any,
>(
  config: MutationConfig<TInput, TOutput, TContext>,
): GraphQLFieldConfig<unknown, TContext>;
export {};