Class default

Index

Constructors

Methods

_verifyNotCommitted commit delete set update

Properties

_committed _firestore _writes

Constructors

constructor

new default(firestore: FirestoreInternal): default
Parameters
- firestore: FirestoreInternal
Returns default
- Defined in FirestoreWriteBatch.ts:43

Methods

_verifyNotCommitted

_verifyNotCommitted(method: string): void
Parameters
- method: string
Returns void
- Defined in FirestoreWriteBatch.ts:49

commit

commit(): Promise<void>
Returns Promise<void>
- Defined in FirestoreWriteBatch.ts:57

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
- Defined in FirestoreWriteBatch.ts:68

set

set<
    AppModelType = DocumentData,
    DbModelType extends DocumentData = DocumentData,
>(
    documentRef: DocumentReference<AppModelType, DbModelType>,
    data: WithFieldValue<AppModelType>,
): this
Type Parameters
- AppModelType = DocumentData
- DbModelType extends DocumentData = DocumentData
Parameters
- documentRef: DocumentReference<AppModelType, DbModelType>
- data: WithFieldValue<AppModelType>
Returns this
- Defined in FirestoreWriteBatch.ts:92
set<
    AppModelType = DocumentData,
    DbModelType extends DocumentData = DocumentData,
>(
    documentRef: DocumentReference<AppModelType, DbModelType>,
    data: PartialWithFieldValue<AppModelType>,
    options: SetOptions,
): this
Type Parameters
- AppModelType = DocumentData
- DbModelType extends DocumentData = DocumentData
Parameters
- documentRef: DocumentReference<AppModelType, DbModelType>
- data: PartialWithFieldValue<AppModelType>
- options: SetOptions
Returns this
- Defined in FirestoreWriteBatch.ts:96

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
- Defined in FirestoreWriteBatch.ts:149

Properties

_committed

_committed: boolean

_firestore

_firestore: FirestoreInternal

_writes

_writes: BatchWrite[]