Skip to content

react-query-firebase / useSignInWithCredentialMutation

Function: useSignInWithCredentialMutation()

ts
function useSignInWithCredentialMutation<TContext>(options?): UseMutationResult<UserCredential, FirebaseError, UseSignInWithCredentialMutationVariables, TContext>;

Defined in: src/web/auth/useSignInWithCredentialMutation.ts:18

Custom hook for handling sign in using credential This hook utilizes the useMutation mechanism to perform the sign-in operation.

Type Parameters

TContext

TContext = unknown

Parameters

options?

Omit<UseMutationOptions<UserCredential, FirebaseError, UseSignInWithCredentialMutationVariables, TContext>, "mutationKey" | "mutationFn"> = {}

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

Returns

UseMutationResult<UserCredential, FirebaseError, UseSignInWithCredentialMutationVariables, TContext>

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

Released under the MIT License.