react-query-firebase / web/auth / useGetRedirectResultMutation
Function: useGetRedirectResultMutation()
ts
function useGetRedirectResultMutation<TContext>(options): UseMutationResult<null | UserCredential, FirebaseError, void, TContext>;
Defined in: web/auth/useGetRedirectResultMutation.ts:14
Custom hook to retrieve redirect result after sign in with redirect. This hook utilizes the useMutation
functionality to support creating new user credentials asynchronously.
Type Parameters
TContext
TContext
= unknown
Parameters
options
Omit
<UseMutationOptions
<UserCredential
| null
, FirebaseError
, void
, TContext
>, "mutationKey"
| "mutationFn"
> = {}
Optional settings to customize the mutation behavior, excluding mutationKey
and mutationFn
.
Returns
UseMutationResult
<null
| UserCredential
, FirebaseError
, void
, TContext
>
The result of the mutation which includes status, user credentials, and error information if any.