Module core

Metadatas linked to a type that holds information:

• on how to convert it to and from firestore.
• the fields remapped
• the conversions of complex fields
• the subcollections
• the fields ignored

Class containing all the metadatas stored in firestorm

Minimal requirements for a firestorm model

Requirements for a firestorm model that is referenced

Relationship metadata

To-many relationship metadatas

To-one relationship metadatas

Newable function of T

Type of a conversion function from a firestore document data object to a FirestormModel

Type of a conversion function from a firestore document data object to a FirestormModel

Type for a firestore document

Alias of IFirestormModel

Dictionary of id and model corresponding to this id

Alias of IMandatoryFirestormModel

Type of a conversion function from a FirestormModel to a firestore document data object

Type of a conversion function from a FirestormModel to a firestore document data object

Kind of relationship

Where to find the referenced document

• 'sibling': looks for the collection next to the collection related to this
• 'root:' looks for the collection starting from the root
• IParentCollectionOptions[]: creates the path to the parent collection

Type for functions passed to firebase's runTransaction

The limit of modifications on a document per transaction

Describes a function that can generate an object