react-query-firebase / useSetDocMutation

Function: useSetDocMutation()

function useSetDocMutation<AppModelType, TContext>(options): UseMutationResult<AppModelType & object, FirebaseError, {
  data: WithFieldValue<AppModelType>;
}, TContext>;

Defined in: src/web/firestore/useSetDocMutation.ts:59

Executes a mutation and returns added document

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

TContext

TContext = unknown

Parameters

options

Configuration options for mutation.

options?

Omit<UseMutationOptions<AppModelType, FirebaseError, { data: WithFieldValue<AppModelType>; }, TContext>, "mutationFn">

Options for useMutation hook excluding mutationFn.

reference

DocumentReference<AppModelType, AppModelType> | null

Reference to a document that must be written

Returns

UseMutationResult<AppModelType & object, FirebaseError, { data: WithFieldValue<AppModelType>; }, TContext>

A mutation result

Example

export const MyComponent = () => {
 const {mutate} = useSetDocMutation({
     options: {
     },
     reference: collection().doc(),
 });

 // ....
 mutate({data: {test: 'value'}});
 // ....
};