Skip to content

react-query-firebase / useSignInWitRedirectMutation

Function: useSignInWitRedirectMutation()

ts
function useSignInWitRedirectMutation<TContext>(options?): UseMutationResult<void, FirebaseError, UseSignInWitRedirectMutationVariables, TContext>;

Defined in: src/web/auth/useSignInWitRedirectMutation.ts:19

Custom hook for handling Firebase authentication using sign-in with redirect functionality. This hook utilizes the useMutation mechanism to perform the sign-in operation.

Type Parameters

TContext

TContext = unknown

Parameters

options?

Omit<UseMutationOptions<void, FirebaseError, UseSignInWitRedirectMutationVariables, TContext>, "mutationKey" | "mutationFn"> = {}

Optional configurations for the mutation, omitting the mutationKey and mutationFn properties.

Returns

UseMutationResult<void, FirebaseError, UseSignInWitRedirectMutationVariables, TContext>

The result object from the useMutation hook, containing the mutation function and its current state.

Released under the MIT License.