react-query-firebase / web/firestore / useBatchWrite

Function: useBatchWrite()

function useBatchWrite(options): UseMutationResult<void, FirebaseError, (batch) => void | Promise<void>, unknown>;

Defined in: web/firestore/useBatchWrite.ts:47

Custom hook to perform batch write operations using Firestore.

Parameters

options

Configuration options for the query.

options?

Omit<UseMutationOptions<void, FirebaseError, (batch) => void | Promise<void>, unknown>, "mutationFn"> = {}

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

Returns

UseMutationResult<void, FirebaseError, (batch) => void | Promise<void>, unknown>

A mutation result

Example

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

 // ....
 mutate(() => {
     ref.update({...})
 });
 // ....
};