react-query-firebase / auth / useSendEmailVerificationMutation
Function: useSendEmailVerificationMutation()
ts
function useSendEmailVerificationMutation<TContext>(options): UseMutationResult<void, FirebaseError, UseSendEmailVerificationMutationVariables, TContext>
Defined in: src/auth/useSendEmailVerificationMutation.ts:17
A custom hook to create a mutation for sending an email verification to a user using Firebase. This uses the useMutation
hook from a query library and wraps it with specific configuration options.
Type Parameters
• TContext = unknown
Parameters
options
Omit
<UseMutationOptions
<FirebaseError
, UseSendEmailVerificationMutationVariables
, TContext
>, "queryKey"
| "queryFn"
> = {}
Configuration options for the mutation, excluding queryKey
and queryFn
.
Returns
UseMutationResult
<void
, FirebaseError
, UseSendEmailVerificationMutationVariables
, TContext
>
An object containing mutation state and functions for managing the mutation lifecycle.