fireorm

fireorm🔥

Index

Enumerations

• FirestoreOperators

Classes

• AbstractFirestoreRepository
• BandRepository
• BaseFirestoreBatchRepository
• BaseFirestoreRepository
• BaseRepository
• FakeExecutor
• FirestoreBatch
• FirestoreBatchSingleRepository
• FirestoreBatchUnit
• FirestoreTransaction
• MetadataStorage
• NoMetadataError
• QueryBuilder
• Test
• TransactionRepository
• ValidationError

Interfaces

• CollectionMetadata
• CollectionMetadataWithSegments
• FullCollectionMetadata
• IBaseRepository
• IBatchRepository
• IEntity
• IFireOrmQueryLine
• IFirestoreBatch
• IFirestoreBatchSingleRepository
• IFirestoreTransaction
• ILimitable
• IMetadataStore
• IOrderByParams
• IOrderable
• IQueryExecutor
• IQueryable
• ISingleBatchRepository
• ITransactionReference
• MetadataStorageConfig
• RepositoryMetadata
• SubCollectionMetadata
• SubCollectionMetadataWithSegments

Type aliases

• BatchOperation
• Constructor
• EntityConstructorOrPath
• EntityConstructorOrPathConstructor
• IEntityConstructor
• IEntityRepositoryConstructor
• IFirestoreVal
• IQueryBuilder
• IQueryBuilderResult
• IRepository
• ISubCollection
• ITransactionReferenceStorage
• ITransactionRepository
• IWherePropParam
• PartialBy
• PartialWithRequiredBy
• RepositoryType
• TestTransactionRepository
• WithOptionalId

Variables

• GetBaseRepository
• GetCustomRepository
• GetRepository
• Initialize
• MockFirebase
• metadataStorage
• setCollection
• setRepository

Functions

• Collection
• CustomRepository
• SubCollection
• _getRepository
• arraysAreEqual
• createBatch
• extractAllGetters
• getBaseRepository
• getCustomRepository
• getMetadataStorage
• getRepository
• getStore
• initialize
• initializeMetadataStorage
• isDocumentReference
• isGeoPoint
• isObject
• isTimestamp
• runTransaction
• serializeEntity

Type aliases

BatchOperation

Ƭ BatchOperation: object

Defined in src/Batch/FirestoreBatchUnit.ts:7

Type declaration:

• collectionMetadata: FullCollectionMetadata

• item: IEntity

• ref: DocumentReference

• type: *“create”

  “update”

  “delete”*

• validateModels: boolean

---

Constructor

Ƭ Constructor: object

Defined in src/types.ts:124

Type declaration:

• new __type(): T

---

EntityConstructorOrPath

Ƭ EntityConstructorOrPath: *Constructor‹T›

string*

Defined in src/types.ts:128

---

EntityConstructorOrPathConstructor

Ƭ EntityConstructorOrPathConstructor: object

Defined in src/types.ts:125

Type declaration:

• new __type(): T

---

IEntityConstructor

Ƭ IEntityConstructor: Constructor‹IEntity›

Defined in src/types.ts:126

---

IEntityRepositoryConstructor

Ƭ IEntityRepositoryConstructor: Constructor‹IRepository‹IEntity››

Defined in src/types.ts:127

---

IFirestoreVal

Ƭ IFirestoreVal: *string

number

Date

boolean

DocumentReference*

Defined in src/types.ts:9

---

IQueryBuilder

Ƭ IQueryBuilder: IQueryable‹T› & IOrderable‹T› & ILimitable‹T›

Defined in src/types.ts:59

---

IQueryBuilderResult

Ƭ IQueryBuilderResult: IFireOrmQueryLine[]

Defined in src/types.ts:33

---

IRepository

Ƭ IRepository: IBaseRepository‹T› & IQueryBuilder‹T› & IQueryExecutor‹T›

Defined in src/types.ts:100

---

ISubCollection

Ƭ ISubCollection: IRepository‹T› & object

Defined in src/types.ts:115

---

ITransactionReferenceStorage

Ƭ ITransactionReferenceStorage: Set‹ITransactionReference›

Defined in src/types.ts:112

---

ITransactionRepository

Ƭ ITransactionRepository: IRepository‹T›

Defined in src/types.ts:104

---

IWherePropParam

Ƭ IWherePropParam: *keyof T

function*

Defined in src/types.ts:35

---

PartialBy

Ƭ PartialBy: Omit‹T, K› & Partial‹Pick‹T, K››

Defined in src/types.ts:3

---

PartialWithRequiredBy

Ƭ PartialWithRequiredBy: Pick‹T, K› & Partial‹Omit‹T, K››

Defined in src/types.ts:4

---

RepositoryType

Ƭ RepositoryType: *“default”

“base”

“custom”

“transaction”*

Defined in src/helpers.ts:7

---

TestTransactionRepository

Ƭ TestTransactionRepository: Pick‹BaseFirestoreRepository‹T›, “runTransaction”›

Defined in src/Transaction/BaseFirestoreTransactionRepository.spec.ts:13

---

WithOptionalId

Ƭ WithOptionalId: Pick‹T, Exclude‹keyof T, “id”›› & Partial‹Pick‹T, “id”››

Defined in src/types.ts:6

Variables

Const GetBaseRepository

• GetBaseRepository: getBaseRepository = getBaseRepository

Defined in src/helpers.ts:86

deprecated Use getBaseRepository. This will be removed in a future version.

---

Const GetCustomRepository

• GetCustomRepository: getCustomRepository = getCustomRepository

Defined in src/helpers.ts:77

deprecated Use getCustomRepository. This will be removed in a future version.

---

Const GetRepository

• GetRepository: getRepository = getRepository

Defined in src/helpers.ts:68

deprecated Use getRepository. This will be removed in a future version.

---

Const Initialize

• Initialize: initialize = initialize

Defined in src/MetadataUtils.ts:45

deprecated Use initialize. This will be removed in a future version.

---

Const MockFirebase

• MockFirebase: any = require(‘mock-cloud-firestore’)

Defined in src/BaseFirestoreRepository.spec.ts:15

Defined in src/helpers.spec.ts:9

Defined in src/Batch/BaseFirestoreBatchRepository.spec.ts:11

Defined in src/Batch/FirestoreBatch.spec.ts:8

Defined in src/Transaction/BaseFirestoreTransactionRepository.spec.ts:9

Defined in src/Transaction/FirestoreTransaction.spec.ts:8

---

Const metadataStorage

• metadataStorage: MetadataStorage‹› = getMetadataStorage()

Defined in src/Transaction/FirestoreTransaction.ts:11

---

Const setCollection

• setCollection: Mock‹any, any› = jest.fn()

Defined in src/Decorators/Collection.spec.ts:3

Defined in src/Decorators/SubCollection.spec.ts:5

---

Const setRepository

• setRepository: Mock‹any, any› = jest.fn()

Defined in src/Decorators/CustomRepository.spec.ts:4

Functions

Collection

▸ Collection(entityName?: string): (Anonymous function)

Defined in src/Decorators/Collection.ts:5

Parameters:

Name	Type
entityName?	string

Returns: (Anonymous function)

---

CustomRepository

▸ CustomRepository‹T›(entity: Constructor‹T›): (Anonymous function)

Defined in src/Decorators/CustomRepository.ts:10

Type parameters:

▪ T: IEntity

Parameters:

Name	Type
entity	Constructor‹T›

Returns: (Anonymous function)

---

SubCollection

▸ SubCollection(entityConstructor: IEntityConstructor, entityName?: string): (Anonymous function)

Defined in src/Decorators/SubCollection.ts:5

Parameters:

Name	Type
entityConstructor	IEntityConstructor
entityName?	string

Returns: (Anonymous function)

---

_getRepository

▸ _getRepository‹T›(entityConstructorOrPath: EntityConstructorOrPath‹T›, repositoryType: RepositoryType): BaseFirestoreRepository‹T›

Defined in src/helpers.ts:10

Type parameters:

▪ T: IEntity

Parameters:

Name	Type
entityConstructorOrPath	EntityConstructorOrPath‹T›
repositoryType	RepositoryType

Returns: BaseFirestoreRepository‹T›

---

arraysAreEqual

▸ arraysAreEqual(arr1: unknown[], arr2: unknown[]): boolean

Defined in src/utils.ts:67

Returns true if arrays are equal

export

Parameters:

Name	Type
arr1	unknown[]
arr2	unknown[]

Returns: boolean

---

Const createBatch

▸ createBatch(): FirestoreBatch‹›

Defined in src/helpers.ts:108

Returns: FirestoreBatch‹›

---

extractAllGetters

▸ extractAllGetters(obj: Record‹string, unknown›): object

Defined in src/utils.ts:9

Extract getters and object in form of data properties

Parameters:

Name	Type
obj	Record‹string, unknown›

Returns: object

with only data properties

---

getBaseRepository

▸ getBaseRepository‹T›(entityOrPath: EntityConstructorOrPath‹T›): BaseFirestoreRepository‹T›

Defined in src/helpers.ts:79

Type parameters:

▪ T: IEntity

Parameters:

Name	Type
entityOrPath	EntityConstructorOrPath‹T›

Returns: BaseFirestoreRepository‹T›

---

getCustomRepository

▸ getCustomRepository‹T›(entityOrPath: EntityConstructorOrPath‹T›): BaseFirestoreRepository‹T›

Defined in src/helpers.ts:70

Type parameters:

▪ T: IEntity

Parameters:

Name	Type
entityOrPath	EntityConstructorOrPath‹T›

Returns: BaseFirestoreRepository‹T›

---

Const getMetadataStorage

▸ getMetadataStorage(): MetadataStorage

Defined in src/MetadataUtils.ts:23

Return exisiting metadataStorage, otherwise create if not present

Returns: MetadataStorage

---

getRepository

▸ getRepository‹T›(entityConstructorOrPath: EntityConstructorOrPath‹T›): BaseFirestoreRepository‹T›

Defined in src/helpers.ts:59

Type parameters:

▪ T: IEntity

Parameters:

Name	Type
entityConstructorOrPath	EntityConstructorOrPath‹T›

Returns: BaseFirestoreRepository‹T›

---

getStore

▸ getStore(): IMetadataStore

Defined in src/MetadataUtils.ts:8

Returns: IMetadataStore

---

Const initialize

▸ initialize(firestore: Firestore, config: MetadataStorageConfig): void

Defined in src/MetadataUtils.ts:30

Parameters:

Name	Type	Default
firestore	Firestore	-
config	MetadataStorageConfig	{ validateModels: false }

Returns: void

---

initializeMetadataStorage

▸ initializeMetadataStorage(): void

Defined in src/MetadataUtils.ts:12

Returns: void

---

isDocumentReference

▸ isDocumentReference(x: unknown): x is DocumentReference

Defined in src/TypeGuards.ts:11

Parameters:

Name	Type
x	unknown

Returns: x is DocumentReference

---

isGeoPoint

▸ isGeoPoint(x: unknown): x is GeoPoint

Defined in src/TypeGuards.ts:7

Parameters:

Name	Type
x	unknown

Returns: x is GeoPoint

---

isObject

▸ isObject(x: unknown): x is Record<string, unknown>

Defined in src/TypeGuards.ts:15

Parameters:

Name	Type
x	unknown

Returns: x is Record<string, unknown>

---

isTimestamp

▸ isTimestamp(x: unknown): x is Timestamp

Defined in src/TypeGuards.ts:3

Parameters:

Name	Type
x	unknown

Returns: x is Timestamp

---

Const runTransaction

▸ runTransaction‹T›(executor: function): Promise‹T›

Defined in src/helpers.ts:88

Type parameters:

▪ T

Parameters:

▪ executor: function

▸ (tran: FirestoreTransaction): Promise‹T›

Parameters:

Name	Type
tran	FirestoreTransaction

Returns: Promise‹T›

---

serializeEntity

▸ serializeEntity‹T›(obj: Partial‹T›, subColMetadata: SubCollectionMetadata[]): Record‹string, unknown›

Defined in src/utils.ts:45

Returns a serializable object from entity

Type parameters:

▪ T: IEntity

Parameters:

Name	Type	Description
obj	Partial‹T›	-
subColMetadata	SubCollectionMetadata[]	Subcollection metadata to remove runtime-created fields

Returns: Record‹string, unknown›

Serialiable object

This site is open source. Improve this page.