A reference to a transaction. The Transaction object passed to a transaction's updateFunction provides the methods to read and write data within the transaction context. See Firestore.runTransaction().

Index

Constructors

Methods

Constructors

Private constructor

Methods

delete

  • delete ( documentRef :  DocumentReference < any > ) : Transaction

  • Deletes the document referred to by the provided DocumentReference.

    Parameters

    Returns Transaction

    This Transaction instance. Used for chaining method calls.

get

set

  • set < T > ( documentRef :  DocumentReference < T > ,  data :  Partial < T > ,  options :  SetOptions ) : Transaction

  • Writes to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created. If you pass SetOptions, the provided data can be merged into the existing document.

    Type parameters

    • T

    Parameters

    • documentRef: DocumentReference<T>

      A reference to the document to be set.

    • data: Partial<T>

      An object of the fields and values for the document.

    • options: SetOptions

      An object to configure the set behavior.

    Returns Transaction

    This Transaction instance. Used for chaining method calls.

  • set < T > ( documentRef :  DocumentReference < T > ,  data :  T ) : Transaction

  • Writes to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created. If you pass SetOptions, the provided data can be merged into the existing document.

    Type parameters

    • T

    Parameters

    • documentRef: DocumentReference<T>

      A reference to the document to be set.

    • data: T

      An object of the fields and values for the document.

    Returns Transaction

    This Transaction instance. Used for chaining method calls.

update

  • update ( documentRef :  DocumentReference < any > ,  data :  UpdateData ) : Transaction

  • Updates fields in the document referred to by the provided DocumentReference. The update will fail if applied to a document that does not exist.

    Parameters

    • documentRef: DocumentReference<any>

      A reference to the document to be updated.

    • data: UpdateData

      An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.

    Returns Transaction

    This Transaction instance. Used for chaining method calls.

  • update ( documentRef :  DocumentReference < any > ,  field :  string | FieldPath ,  value :  any ,  ... moreFieldsAndValues :  any [] ) : Transaction

  • Updates fields in the document referred to by the provided DocumentReference. The update will fail if applied to a document that does not exist.

    Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.

    Parameters

    • documentRef: DocumentReference<any>

      A reference to the document to be updated.

    • field: string | FieldPath

      The first field to update.

    • value: any

      The first value.

    • Rest ...moreFieldsAndValues: any[]

      Additional key/value pairs.

    Returns Transaction

    A Promise resolved once the data has been successfully written to the backend (Note that it won't resolve while you're offline).