fireorm

Class: FirestoreBatchUnit

Hierarchy

• FirestoreBatchUnit

Index

Constructors

• constructor

Properties

• firestoreRef
• operations
• status

Methods

• add
• commit
• validate

Constructors

constructor

+ new FirestoreBatchUnit(firestoreRef: Firestore): FirestoreBatchUnit

Defined in src/Batch/FirestoreBatchUnit.ts:17

Parameters:

Name	Type
firestoreRef	Firestore

Returns: FirestoreBatchUnit

Properties

Private firestoreRef

• firestoreRef: Firestore

Defined in src/Batch/FirestoreBatchUnit.ts:19

---

operations

• operations: BatchOperation‹IEntity›[] = []

Defined in src/Batch/FirestoreBatchUnit.ts:17

---

Private status

• status: *“pending”

“committing”* = “pending”

Defined in src/Batch/FirestoreBatchUnit.ts:16

Methods

add

▸ add‹T›(type: BatchOperation["type"], `item`: T, `ref`: DocumentReference, `collectionMetadata`: [FullCollectionMetadata](/interfaces/fullcollectionmetadata.html), `validateModels`: boolean): *void*

Defined in src/Batch/FirestoreBatchUnit.ts:21

Type parameters:

▪ T: IEntity

Parameters:

Name	Type
type	BatchOperation["type"]
item	T
ref	DocumentReference
collectionMetadata	FullCollectionMetadata
validateModels	boolean

Returns: void

---

commit

▸ commit(): Promise‹WriteResult‹›[]›

Defined in src/Batch/FirestoreBatchUnit.ts:37

Returns: Promise‹WriteResult‹›[]›

---

validate

▸ validate(item: IEntity, Entity: Constructor‹IEntity›): Promise‹ValidationError[]›

Defined in src/Batch/FirestoreBatchUnit.ts:80

Parameters:

Name	Type
item	IEntity
Entity	Constructor‹IEntity›

Returns: Promise‹ValidationError[]›

This site is open source. Improve this page.