react-query-firebase / useSignInWithCustomTokenMutation

Function: useSignInWithCustomTokenMutation()

function useSignInWithCustomTokenMutation(options?): UseMutationResult<UserCredential, FirebaseError, {
  customToken: string;
}, unknown>;

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

Executes a mutation and returns users credentials

Parameters

options?

Configuration options for the mutation.

options?

Omit<UseMutationOptions<UserCredential, FirebaseError, { customToken: string; }, unknown>, "mutationFn"> = {}

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

Returns

UseMutationResult<UserCredential, FirebaseError, { customToken: string; }, unknown>

A mutation result

Example

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

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