react-query-firebase / useSignInWitEmailAndPasswordMutation
Function: useSignInWitEmailAndPasswordMutation()
ts
function useSignInWitEmailAndPasswordMutation<TContext>(options?): UseMutationResult<UserCredential, FirebaseError, UseSignInWitEmailAndPasswordMutationVariables, TContext>;Defined in: src/web/auth/useSignInWitEmailAndPasswordMutation.ts:20
Custom hook to perform a sign-in operation using email and password with Firebase Authentication. It utilizes the useMutation hook to manage the asynchronous operation and its state.
Type Parameters
TContext
TContext = unknown
Parameters
options?
Omit<UseMutationOptions<UserCredential, FirebaseError, UseSignInWitEmailAndPasswordMutationVariables, TContext>, "mutationKey" | "mutationFn"> = {}
Options to configure the mutation, excluding 'mutationKey' and 'mutationFn'.
Returns
UseMutationResult<UserCredential, FirebaseError, UseSignInWitEmailAndPasswordMutationVariables, TContext>
A mutation object containing the result of the sign-in process and helper functions.