react-query-firebase / react-native/auth / useSignOutMutation

Function: useSignOutMutation()

function useSignOutMutation<TContext>(options): UseMutationResult<void, NativeFirebaseError, void, TContext>;

Defined in: react-native/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

TContext = unknown

Parameters

options

Omit<UseMutationOptions<void, NativeFirebaseError, void, TContext>, "queryKey" | "queryFn"> = {}

Configuration options for the mutation, excluding "queryKey" and "queryFn".

Returns

UseMutationResult<void, NativeFirebaseError, void, TContext>

A mutation object for handling the sign-out process, including methods for mutating and state tracking.