fireorm

Class: FirestoreBatch

Hierarchy

• FirestoreBatch

Implements

• IFirestoreBatch

Index

Constructors

• constructor

Properties

• batch
• firestoreRef

Methods

• commit
• getRepository
• getSingleRepository

Constructors

constructor

+ new FirestoreBatch(firestoreRef: Firestore): FirestoreBatch

Defined in src/Batch/FirestoreBatch.ts:9

Parameters:

Name	Type
firestoreRef	Firestore

Returns: FirestoreBatch

Properties

Private batch

• batch: FirestoreBatchUnit

Defined in src/Batch/FirestoreBatch.ts:9

---

Protected firestoreRef

• firestoreRef: Firestore

Defined in src/Batch/FirestoreBatch.ts:11

Methods

commit

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

Implementation of IFirestoreBatch

Defined in src/Batch/FirestoreBatch.ts:51

Commits current batch.

template

memberof FirestoreBatch

Returns: Promise‹WriteResult‹›[]›

---

getRepository

▸ getRepository‹T›(pathOrConstructor: EntityConstructorOrPath‹T›): BaseFirestoreBatchRepository‹T›

Implementation of IFirestoreBatch

Defined in src/Batch/FirestoreBatch.ts:24

Returns a batch repository of T.

memberof FirestoreBatch

Type parameters:

▪ T: IEntity

Parameters:

Name	Type
pathOrConstructor	EntityConstructorOrPath‹T›

Returns: BaseFirestoreBatchRepository‹T›

---

getSingleRepository

▸ getSingleRepository‹T›(pathOrConstructor: EntityConstructorOrPath‹T›): FirestoreBatchSingleRepository‹T›

Implementation of IFirestoreBatch

Defined in src/Batch/FirestoreBatch.ts:38

Returns a batch repository of a single entity. Required to maintain current features and will be deleted in the next major version.

memberof FirestoreBatch

Type parameters:

▪ T: IEntity

Parameters:

Name	Type
pathOrConstructor	EntityConstructorOrPath‹T›

Returns: FirestoreBatchSingleRepository‹T›

This site is open source. Improve this page.