c

react_apollo

UseMutation

case class UseMutation[T, TVars <: Object]() extends Product with Serializable

Because there are some duplicative types in the signatures which become burdensome, this helper class reduces type noise. Instantiate the object then use values and methods in it without need to always specify the types.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UseMutation
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new UseMutation()

Type Members

  1. type TArg = T
  2. type TVarsArg = TVars

Value Members

  1. def makeClientOptions(mutation: DocumentNode, context: UndefOr[Object] = js.undefined, fetchPolicy: UndefOr[FetchPolicy] = js.undefined, errorPolicy: UndefOr[ErrorPolicy] = js.undefined, variables: UndefOr[TVars] = js.undefined, unsafeVariables: UndefOr[Dynamic] = js.undefined, update: UndefOr[MutationUpdaterFn[T]] = js.undefined, awaitRefetchQueries: UndefOr[Boolean] = js.undefined, updateQueries: UndefOr[MutationQueryReducersMap[T, Object]] = js.undefined, optimisticResponse: UndefOr[|[T, Function1[TVars, T]]] = js.undefined): MutationOptions[T, TVars]

    Make apollo_client.QueryOptions for the ApolloClient returned from useMutation which are slightly different than MutationHookOptions used in the hook! This primarily exists so we can get a js.Promise to throw an exception to the suspense mechanism.

  2. def makeFunctionOptions(unsafeVariables: UndefOr[Dynamic] = js.undefined, variables: UndefOr[TVars] = js.undefined, optimisticResponseStrict: UndefOr[T] = js.undefined, optimisticResponse: UndefOr[Function1[TVars, T]] = js.undefined, refetchQueriesByName: UndefOr[Array[String]] = js.undefined, awaitRefetchQueries: UndefOr[Boolean] = js.undefined, update: UndefOr[MutationUpdaterFn[T]] = js.undefined, context: UndefOr[Object] = js.undefined, fetchPolicy: UndefOr[WatchQueryFetchPolicy] = js.undefined): MutationFunctionOptions[T, TVars]

    Options needed for the "caller" function return from the mutation hook.

    Options needed for the "caller" function return from the mutation hook. Other config info, such as error policy and the operation itself are take from the hook.

  3. def makeOptions(awaitRefetchQueries: UndefOr[Boolean] = js.undefined, client: UndefOr[ApolloClient] = js.undefined, context: UndefOr[Object] = js.undefined, errorPolicy: UndefOr[ErrorPolicy] = js.undefined, fetchPolicy: UndefOr[WatchQueryFetchPolicy] = js.undefined, ignoreResults: UndefOr[Boolean] = js.undefined, mutation: UndefOr[DocumentNode] = js.undefined, notifyOnNetworkStatusChange: UndefOr[Boolean] = js.undefined, onCompleted: UndefOr[Function1[UndefOr[T], Unit]] = js.undefined, onError: UndefOr[Function1[ApolloError, Unit]] = js.undefined, update: UndefOr[MutationUpdaterFn[T]] = js.undefined, variables: UndefOr[TVars] = js.undefined, unsafeVariables: UndefOr[Dynamic] = js.undefined): MutationHookOptions[T, TVars]

    Make MutationHookOptions

  4. def productElementNames: Iterator[String]
    Definition Classes
    Product
  5. def useMutation(mutation: DocumentNode, options: UndefOr[|[MutationHookOptions[T, TVars], Dynamic]] = js.undefined): (Function1[MutationFunctionOptions[T, TVars], Promise[ExecutionResult[T]]], MutationResult[T])