react-query-firebase / useSignInAnonymouslyMutation

Function: useSignInAnonymouslyMutation()

function useSignInAnonymouslyMutation(options?): UseMutationResult<UserCredential, NativeFirebaseError, void, unknown>;

Defined in: src/web/auth/useSignInAnonymouslyMutation.ts:41

Executes a mutation and returns users credentials

Parameters

options?

Configuration options for the mutation.

options?

Omit<UseMutationOptions<UserCredential, NativeFirebaseError, void, unknown>, "mutationFn"> = {}

Options for useMutation hook excluding mutationFn. MutationKey will be equal to reference.path by default.

Returns

UseMutationResult<UserCredential, NativeFirebaseError, void, unknown>

A mutation result

Example

export const MyComponent = () => {
 const {mutate} = useSignInAnonymouslyMutation({
     options: {
     },
 });

 // ....
 mutate();
 // ....
};