react-query-firebase / auth / useSignOutMutation
Function: useSignOutMutation()
ts
function useSignOutMutation<TContext>(options): UseMutationResult<void, FirebaseError, void, TContext>Defined in: src/auth/useSignOutMutation.ts:15
Custom hook for handling the sign-out mutation using Firebase authentication. It wraps the useMutation hook to provide a sign-out function with Firebase.
Type Parameters
• TContext = unknown
Parameters
options
Omit<UseMutationOptions<FirebaseError, TContext>, "queryKey" | "queryFn"> = {}
Configuration options for the mutation, excluding "queryKey" and "queryFn".
Returns
UseMutationResult<void, FirebaseError, void, TContext>
A mutation object for handling the sign-out process, including methods for mutating and state tracking.