react-query-firebase / web/firestore / useRunTransaction

Function: useRunTransaction()

function useRunTransaction<T, TContext>(options): UseMutationResult<T, FirebaseError, <T>(transaction) => T, TContext>;

Defined in: web/firestore/useRunTransaction.ts:45

Executes a Firestore transaction

Type Parameters

T

T = unknown

TContext

TContext = unknown

Parameters

options

Configuration options for the mutation.

options?

Omit<UseMutationOptions<T, FirebaseError, <T>(transaction) => T, TContext>, "mutationFn"> = {}

Reqct-mutation options that shall omit mutationFn

Returns

UseMutationResult<T, FirebaseError, <T>(transaction) => T, TContext>

An object representing mutation

Example

export const MyComponent = () => {
 const doc = useGetDocData({
     options: {
         queryKey: ['key']
     },
     reference: collection(),
     path: 'id'
 });
 console.log(doc);
};