Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeoTransaction

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

Hierarchy

  • GeoTransaction

Index

Constructors

Accessors

Methods

Constructors

  • new GeoTransaction(_transaction: Transaction | Transaction, _customKey?: string): GeoTransaction
  • Parameters

    • _transaction: Transaction | Transaction

      The Transaction instance.

    • Optional _customKey: string

      Key to use for GeoPoints in a transaction.

    Returns GeoTransaction

Accessors

  • get native(): Transaction | Transaction

Methods

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

    Parameters

    Returns GeoTransaction

    This GeoTransaction instance. Used for chaining method calls.

Generated using TypeDoc