react-query-firebase / web/firestore / useDeleteDocMutation

Function: useDeleteDocMutation()

function useDeleteDocMutation<AppModelType, TContext>(options): UseMutationResult<void, FirebaseError, void, TContext>;

Defined in: web/firestore/useDeleteDocMutation.ts:53

Executes a query with specified constraints and returns the count of matched documents.

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

TContext

TContext = unknown

Parameters

options

Configuration options for the query.

options?

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

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

reference

null | DocumentReference<AppModelType, AppModelType>

A reference to a firestore document

Returns

UseMutationResult<void, FirebaseError, void, TContext>

A mutation result

Example

export const MyComponent = () => {
 const {mutate} = useDeleteDocMutation({
     options: {
     },
     reference: document(),
 });

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