Class default

constructor

• new default(firestore: FirestoreInternal, meta: TransactionMeta): default

  Parameters

  • firestore: FirestoreInternal
  • meta: TransactionMeta

  Returns default

_prepare

• _prepare(): void

  Clears the command buffer and any pending result in prep for the next transaction iteration attempt.

  Returns void

delete

• delete<
      AppModelType = DocumentData,
      DbModelType extends DocumentData = DocumentData,
  >(
      documentRef: DocumentReference<AppModelType, DbModelType>,
  ): this

  Type Parameters

  • AppModelType = DocumentData
  • DbModelType extends DocumentData = DocumentData

  Parameters

  • documentRef: DocumentReference<AppModelType, DbModelType>

  Returns this

get

• get<
      AppModelType = DocumentData,
      DbModelType extends DocumentData = DocumentData,
  >(
      documentRef: DocumentReference<AppModelType, DbModelType>,
  ): Promise<DocumentSnapshot<AppModelType, DbModelType>>

  Reads the document referenced by the provided DocumentReference.

  Type Parameters

  • AppModelType = DocumentData
  • DbModelType extends DocumentData = DocumentData

  Parameters

  • documentRef: DocumentReference<AppModelType, DbModelType>

  Returns Promise<DocumentSnapshot<AppModelType, DbModelType>>

set

• set<
      AppModelType = DocumentData,
      DbModelType extends DocumentData = DocumentData,
  >(
      documentRef: DocumentReference<AppModelType, DbModelType>,
      data: WithFieldValue<AppModelType>,
  ): this

  Writes to the document referred to by the provided DocumentReference.

  Type Parameters

  • AppModelType = DocumentData
  • DbModelType extends DocumentData = DocumentData

  Parameters

  • documentRef: DocumentReference<AppModelType, DbModelType>
  • data: WithFieldValue<AppModelType>

  Returns this

• set<
      AppModelType = DocumentData,
      DbModelType extends DocumentData = DocumentData,
  >(
      documentRef: DocumentReference<AppModelType, DbModelType>,
      data: PartialWithFieldValue<AppModelType>,
      options: SetOptions,
  ): this

  Writes to the document referred to by the provided DocumentReference.

  Type Parameters

  • AppModelType = DocumentData
  • DbModelType extends DocumentData = DocumentData

  Parameters

  • documentRef: DocumentReference<AppModelType, DbModelType>
  • data: PartialWithFieldValue<AppModelType>
  • options: SetOptions

  Returns this

update

• update<
      AppModelType = DocumentData,
      DbModelType extends DocumentData = DocumentData,
  >(
      documentRef: DocumentReference<AppModelType, DbModelType>,
      ...args: unknown[],
  ): this

  Type Parameters

  • AppModelType = DocumentData
  • DbModelType extends DocumentData = DocumentData

  Parameters

  • documentRef: DocumentReference<AppModelType, DbModelType>
  • ...args: unknown[]

  Returns this

_calledGetCount

_commandBuffer

_firestore

_meta

_pendingResult