react-query-firebase / firestore / useDeleteDocMutation
Function: useDeleteDocMutation()
ts
function useDeleteDocMutation<AppModelType, DbModelType, TContext>(options): UseMutationResult<void, FirebaseError, void, TContext>Defined in: src/firestore/useDeleteDocMutation.ts:27
A custom hook that provides a mutation function to delete a document from the database.
Type Parameters
• AppModelType extends DocumentData = DocumentData
• DbModelType extends DocumentData = DocumentData
• TContext = unknown
Parameters
options
UseDeleteDocMutationOptions<AppModelType, DbModelType, TContext>
An object containing the reference to the document and additional options for the mutation.
Returns
UseMutationResult<void, FirebaseError, void, TContext>
An object returned by the useMutation hook which includes properties and methods to control the mutation's execution and track its state.