useMutationState<T> function

VoltMutation<T> useMutationState<T>({ required Future<bool> mutationFn(T params), void onSuccess(T? params)?, void onError(T? params)?, })

Creates a mutation for example to modify data on a server.

The mutation does not automatically invalidate any queries. To invalidate queries, use the useQueryClient hook and call QueryClient.prefetchQuery in the onSuccess callback. This allows for manual and flexible query invalidation.

Implementation

VoltMutation<T> useMutationState<T>({
  required Future<bool> Function(T params) mutationFn,
  void Function(T? params)? onSuccess,
  void Function(T? params)? onError,
}) {
  final state = useState(const VoltMutationState());

  return VoltMutation(
    mutationFn: mutationFn,
    state: state,
    onSuccess: onSuccess,
    onError: onError,
  );
}