react-query-firebase / firestore / useAddDocMutation
Function: useAddDocMutation()
ts
function useAddDocMutation<AppModelType, DbModelType, TContext>(options): UseMutationResult<AppModelType, FirebaseError, UseAddDocMutationValues<AppModelType>, TContext>Defined in: src/firestore/useAddDocMutation.ts:42
Provides a mutation hook to add a document to a Firestore collection utilizing React Query's useMutation. It handles addition and optional conversion of the document data in Firestore.
Type Parameters
• AppModelType extends DocumentData = DocumentData
• DbModelType extends DocumentData = DocumentData
• TContext = unknown
Parameters
options
UseAddDocMutationOptions<AppModelType, DbModelType, TContext>
Options for the mutation hook
Returns
UseMutationResult<AppModelType, FirebaseError, UseAddDocMutationValues<AppModelType>, TContext>
The mutation hook result containing status, error, and data of the mutation process.