Class Transaction

A Firestore transaction. All reads must happen before any writes.

Index

Constructors

Methods

delete get set update

Constructors

constructor

new Transaction(
    _firestore: FirestoreClientInterface & {
        _getDocument(
            path: string,
            transactionId?: string,
        ): Promise<FirestoreDocument>;
    },
    _transactionId: string,
): Transaction
Parameters
- _firestore: FirestoreClientInterface & {
      _getDocument(
          path: string,
          transactionId?: string,
      ): Promise<FirestoreDocument>;
  }
- _transactionId: string
Returns Transaction
- Defined in transaction.ts:28

Methods

delete

delete(ref: DocumentReference): Transaction
Queue a delete operation.
Parameters
- ref: DocumentReference
Returns Transaction
- Defined in transaction.ts:138

get

get<T = DocumentData>(ref: DocumentReference<T>): Promise<DocumentSnapshot<T>>
Get a document within this transaction.
Type Parameters
- T = DocumentData
Parameters
- ref: DocumentReference<T>
Returns Promise<DocumentSnapshot<T>>
- Defined in transaction.ts:41

set

set<T = DocumentData>(
    ref: DocumentReference<T>,
    data: T,
    options?: { merge?: boolean },
): Transaction
Queue a set operation.
Type Parameters
- T = DocumentData
Parameters
- ref: DocumentReference<T>
- data: T
- Optionaloptions: { merge?: boolean }
Returns Transaction
- Defined in transaction.ts:54

update

update<T = DocumentData>(
ref: DocumentReference<T>,
data: Partial<T>,
): Transaction
Queue an update operation.
Type Parameters
- T = DocumentData
Parameters
- ref: DocumentReference<T>
- data: Partial<T>
Returns Transaction
- Defined in transaction.ts:94