react-query-firebase / useDeleteTokenMutation

Function: useDeleteTokenMutation()

function useDeleteTokenMutation(options): UseMutationResult<void, FirebaseError, void, unknown>;

Defined in: src/web/messaging/useDeleteTokenMutation.ts:39

Executes a mutation and deletes token for push notifications

Parameters

options

Configuration options for the mutation.

options?

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

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

Returns

UseMutationResult<void, FirebaseError, void, unknown>

A mutation result

Example

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

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