Skip to content

react-query-firebase / useGetTokenMutation

Function: useGetTokenMutation()

ts
function useGetTokenMutation(options): UseMutationResult<{
  token: string;
}, FirebaseError, {
  vapidKey: string;
}, unknown>;

Defined in: src/web/messaging/useGetTokenMutation.ts:52

Executes a mutation and returns token for.current instance

Parameters

options

Configuration options for the mutation.

options?

Omit<UseMutationOptions<{ token: string; }, FirebaseError, { vapidKey: string; }, unknown>, "mutationFn"> = {}

Options for useMutation hook excluding mutationFn.

Returns

UseMutationResult<{ token: string; }, FirebaseError, { vapidKey: string; }, unknown>

A mutation result

Example

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

 // ....
 mutate({vapidKey: 'key'});
 // ....
};

Released under the MIT License.