Interface RetreeConvexMutation<Mutation>

Type Parameters

• Mutation extends MutationReference = MutationReference

• RetreeConvexMutation(
      args: FunctionArgs<Mutation>,
      options?: RetreeConvexMutationOptions<Mutation>,
  ): Promise<Awaited<FunctionReturnType<Mutation>>>

  Run the Convex mutation.

  Parameters

  • args: FunctionArgs<Mutation>

    Mutation arguments.

  • Optionaloptions: RetreeConvexMutationOptions<Mutation>

    Optional optimistic update hook.

  Returns Promise<Awaited<FunctionReturnType<Mutation>>>

  Promise for the Convex mutation result.