Class Repository<T_model>`Abstract`

A repository is a typed access to a specific collection

Type Parameters

T_model extends IFirestormModel

Hierarchy (View Summary)

Repository
- DocumentRepository
- CollectionRepository

Constructors

constructor

new Repository<T_model extends IFirestormModel>(
    firestorm: Firestorm,
    type: Type<T_model>,
    path?: PathLike,
): Repository<T_model>
Creates a new repository on a model
Type Parameters
- T_model extends IFirestormModel
Parameters
- firestorm: Firestorm
  The instance of firestORM this repository connects to
- type: Type<T_model>
  Type on which the repository operates
- Optionalpath: PathLike
  The optional parent collections for repositories of subcollections
Returns Repository<T_model>
- Defined in packages/firestorm/src/repositories/repository.ts:41

Properties

`Protected` `Readonly`firestorm

firestorm: Firestorm

Instance of firestORM this repository uses to reach the DB

`Protected`path

path: Path

Path of the repository

Accessors

collectionPath

get collectionPath(): string
Gets the path to the collection of this repository

Returns string
- Defined in packages/firestorm/src/repositories/repository.ts:92

`Protected`collectionRef

get collectionRef(): CollectionReference<DocumentData, DocumentData>
Gets a collection reference to the collection of this repository

Returns CollectionReference<DocumentData, DocumentData>
Collection ref to this repository
- Defined in packages/firestorm/src/repositories/repository.ts:140

documentBlueprint

get documentBlueprint(): Record<string, PropertyBluePrint>
Gets the blueprint for a document built with the type of this repository

Returns Record<string, PropertyBluePrint>
Deprecated
⚠️ Not ready
- Defined in packages/firestorm/src/repositories/repository.ts:324

`Protected`firestore

get firestore(): Firestore
Instance of firestore this repository uses to reach the DB

Returns Firestore
- Defined in packages/firestorm/src/repositories/repository.ts:31

isOnSubcollection

get isOnSubcollection(): boolean
Whether or not this repository is a subcollection or not

Returns boolean
- Defined in packages/firestorm/src/repositories/repository.ts:85

`Protected`storage

get storage(): FirestormMetadataStore
The storage of metadatas of this repository

Returns FirestormMetadataStore
- Defined in packages/firestorm/src/repositories/repository.ts:71

type

get type(): Type<T_model>
Gets the type this repository work on

Returns Type<T_model>
- Defined in packages/firestorm/src/repositories/repository.ts:55

`Protected`typeMetadata

get typeMetadata(): FirestormMetadata<T_model>
The metadatas corresponding to the type of this repository

Returns FirestormMetadata<T_model>
- Defined in packages/firestorm/src/repositories/repository.ts:78

`Protected`typeName

get typeName(): string
Gets the name of the type.

Returns string
Deprecated
Don't rely on its result to do stuff, the name will get mangled after compilation.
- Defined in packages/firestorm/src/repositories/repository.ts:64

Methods

`Protected`createIncluder

createIncluder(...models: T_model[]): IncludeResolver<IFirestormModel, T_model>
Creates an includer that can be resolved later
Parameters
- ...models: T_model[]
  Models to resolve
Returns IncludeResolver<IFirestormModel, T_model>
The resolver created
- Defined in packages/firestorm/src/repositories/repository.ts:244

documentsToModels

documentsToModels(documents: FirestoreDocument[]): T_model[]
Converts multiple documents to their corresponding model
Parameters
- documents: FirestoreDocument[]
  Documents to convert
Returns T_model[]
The converted models
- Defined in packages/firestorm/src/repositories/repository.ts:298

documentToModel

documentToModel(document: FirestoreDocument): T_model
Converts a document to a model (if the id is not in the document, it is lost in the process)
Parameters
- document: FirestoreDocument
  Document to convert
Returns T_model
The converted model
- Defined in packages/firestorm/src/repositories/repository.ts:289

`Protected`firestoreDocumentSnapshotToModel

firestoreDocumentSnapshotToModel(documentSnapshot: DocumentSnapshot): T_model
Converts a snapshot to a model
Parameters
- documentSnapshot: DocumentSnapshot
  Document snapshot in firestore
Returns T_model
Converts a document snapshot to a model
- Defined in packages/firestorm/src/repositories/repository.ts:212

`Protected`getDocumentRef

getDocumentRef(id: string): DocumentReference
Gets a reference to the document corresponding to this id.
Parameters
- id: string
  Id for which you want a document ref
Returns DocumentReference
A document ref corresponding to the model
- Defined in packages/firestorm/src/repositories/repository.ts:104
getDocumentRef(model: IFirestormModel): DocumentReference
Gets a reference to the document corresponding to this model.

If the model doesn't have any id, it will give you a reference to a new document, generate an id and assign it to the model
Parameters
- model: IFirestormModel
  Model for which you want a document ref
Returns DocumentReference
A document ref corresponding to the model
- Defined in packages/firestorm/src/repositories/repository.ts:113
getDocumentRef(modelOrId: string | IFirestormModel): DocumentReference
Gets a reference to the document corresponding to this model.
Parameters
- modelOrId: string | IFirestormModel
  Id or model for which you want a document ref
Returns DocumentReference
A document ref corresponding to the model
- Defined in packages/firestorm/src/repositories/repository.ts:120

`Protected`getDocumentRefs

getDocumentRefs(ids: string[]): DocumentReference<DocumentData, DocumentData>[]
Gets a document reference for each of the models provided.
Parameters
- ids: string[]
  Ids for which you want document refs
Returns DocumentReference<DocumentData, DocumentData>[]
A document ref for each of the models provided in the same order

See
getDocumentRef For the rules on each individual model/documentRef
- Defined in packages/firestorm/src/repositories/repository.ts:152
getDocumentRefs(
models: IFirestormModel[],
): DocumentReference<DocumentData, DocumentData>[]
Gets a document reference for each of the models provided.
Parameters
- models: IFirestormModel[]
  Models for which you want document refs
Returns DocumentReference<DocumentData, DocumentData>[]
A document ref for each of the models provided in the same order

See
getDocumentRef For the rules on each individual model/documentRef
- Defined in packages/firestorm/src/repositories/repository.ts:161
getDocumentRefs(
modelsOrIds: (string | IFirestormModel)[],
): DocumentReference<DocumentData, DocumentData>[]
Gets a document reference for each of the models provided.
Parameters
- modelsOrIds: (string | IFirestormModel)[]
  Ids or models for which you want document refs
Returns DocumentReference<DocumentData, DocumentData>[]
A document ref for each of the models provided in the same order
- Defined in packages/firestorm/src/repositories/repository.ts:168

getRepositoryFromFunction

getRepositoryFromFunction<
    R extends Repository<T_linked_model>,
    T_linked_model extends IFirestormModel,
>(
    generator: RepositoryInstantiator<R, T_linked_model>,
    type: Type<T_linked_model>,
    location: PathLike,
): R
Creates a repository using a generator function
Type Parameters
- R extends Repository<T_linked_model>
  Type of the repository
- T_linked_model extends IFirestormModel
  Type of the model of the new repo
Parameters
- generator: RepositoryInstantiator<R, T_linked_model>
  Generator function of the repository
- type: Type<T_linked_model>
  Type of the model
- location: PathLike
  The path to the collection or document to get a repository on
Returns R
- Defined in packages/firestorm/src/repositories/repository.ts:276

modelsToDocuments

modelsToDocuments(models: Partial<T_model>[]): FirestoreDocument[]
Converts multiple models to their corresponding document
Parameters
- models: Partial<T_model>[]
  Models to convert
Returns FirestoreDocument[]
The converted documents
- Defined in packages/firestorm/src/repositories/repository.ts:316

modelToDocument

modelToDocument(model: Partial<T_model>): FirestoreDocument
Converts a partial model to a document
Parameters
- model: Partial<T_model>
  Model to convert
Returns FirestoreDocument
The converted document
- Defined in packages/firestorm/src/repositories/repository.ts:307

pathToDocument

pathToDocument(modelOrId: string | IFirestormModel): string
Builds the path to a document
Parameters
- modelOrId: string | IFirestormModel
  Model or id for which you want the Firestore's DB path
Returns string
- Defined in packages/firestorm/src/repositories/repository.ts:200

`Protected`resolveIncludesAsync

resolveIncludesAsync(
includes: RelationshipIncludes<T_model>,
...models: T_model[],
): Promise<IncludeResolver<IFirestormModel, T_model>>
Creates an includer that is resolved immediately. It can still be reused.
Parameters
- includes: RelationshipIncludes<T_model>
  Includes for the model
- ...models: T_model[]
  Models to resolve
Returns Promise<IncludeResolver<IFirestormModel, T_model>>
- Defined in packages/firestorm/src/repositories/repository.ts:260

`Protected` `Abstract`resolveRelationshipLocation

resolveRelationshipLocation(location: PathLike): Path
Build a path to a new ressource using the information of the repository and a way to locate the other resource
Parameters
- location: PathLike
  Location of the other resource relative to this.
Returns Path
- Defined in packages/firestorm/src/repositories/repository.ts:237

`Protected`runTransactionAsync

runTransactionAsync(
transactionFnc: TransactionFnc,
options?: TransactionOptions,
): Promise<void>
Runs a tansaction on the transaction function provided
Parameters
- transactionFnc: TransactionFnc
  Operations to do durring the transaction
- Optionaloptions: TransactionOptions
  Transaction options
Returns Promise<void>
- Defined in packages/firestorm/src/repositories/repository.ts:178

`Protected`toFirestoreQuery

toFirestoreQuery(firestormQuery: IQueryBuildBlock | Query): Query
Converts a firestORM query to a firestore query
Parameters
- firestormQuery: IQueryBuildBlock | Query
  Query to convert
Returns Query
The firestorm query
- Defined in packages/firestorm/src/repositories/repository.ts:191

Class Repository<T_model>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Repository<T_model>

Properties

Protected Readonlyfirestorm

Protectedpath

Accessors

collectionPath

Returns string

ProtectedcollectionRef

Returns CollectionReference<DocumentData, DocumentData>

documentBlueprint

Returns Record<string, PropertyBluePrint>

Deprecated

Protectedfirestore

Returns Firestore

isOnSubcollection

Returns boolean

Protectedstorage

Returns FirestormMetadataStore

type

Returns Type<T_model>

ProtectedtypeMetadata

Returns FirestormMetadata<T_model>

ProtectedtypeName

Returns string

Deprecated

Methods

ProtectedcreateIncluder

Parameters

Returns IncludeResolver<IFirestormModel, T_model>

documentsToModels

Parameters

Returns T_model[]

documentToModel

Parameters

Returns T_model

ProtectedfirestoreDocumentSnapshotToModel

Parameters

Returns T_model

ProtectedgetDocumentRef

Parameters

Returns DocumentReference

Parameters

Returns DocumentReference

Parameters

Returns DocumentReference

ProtectedgetDocumentRefs

Parameters

Returns DocumentReference<DocumentData, DocumentData>[]

See

Parameters

Returns DocumentReference<DocumentData, DocumentData>[]

See

Parameters

Returns DocumentReference<DocumentData, DocumentData>[]

getRepositoryFromFunction

Type Parameters

Parameters

Returns R

modelsToDocuments

Parameters

Returns FirestoreDocument[]

modelToDocument

Parameters

Returns FirestoreDocument

pathToDocument

Parameters

Returns string

ProtectedresolveIncludesAsync

Class Repository<T_model>`Abstract`

`Protected` `Readonly`firestorm

`Protected`path

`Protected`collectionRef

`Protected`firestore

`Protected`storage

`Protected`typeMetadata

`Protected`typeName

`Protected`createIncluder

`Protected`firestoreDocumentSnapshotToModel

`Protected`getDocumentRef

`Protected`getDocumentRefs

`Protected`resolveIncludesAsync

`Protected` `Abstract`resolveRelationshipLocation

`Protected`runTransactionAsync

`Protected`toFirestoreQuery