react-query-firebase / auth / useUpdateProfileMutation
Function: useUpdateProfileMutation()
ts
function useUpdateProfileMutation<TContext>(options): UseMutationResult<void, FirebaseError, UseUpdateProfileMutationVariables, TContext>
Defined in: src/auth/useUpdateProfileMutation.ts:18
Custom hook to manage the mutation for updating a user's profile. Utilizes Firebase for updating the user's display name.
Type Parameters
• TContext = unknown
Parameters
options
Omit
<UseMutationOptions
<FirebaseError
, UseUpdateProfileMutationVariables
, TContext
>, "mutationKey"
| "mutationFn"
> = {}
Configuration options for the mutation, excluding mutationKey and mutationFn.
Returns
UseMutationResult
<void
, FirebaseError
, UseUpdateProfileMutationVariables
, TContext
>
The result of the mutation operation including statuses, data, and error information.