@jiway/firestorm-core - v1.1.1
    Preparing search index...

    Module core

    Classes

    Base

    Converter of integers in different bases

    FirestoreIdBase

    Converter of firestorm ids to integers

    FirestormMetadata

    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
    FirestormMetadataStore

    Class containing all the metadatas stored in firestorm

    FirestormPropertyMetadata

    Class holding informations about how to serialize/deserialize a property of a firestorm model

    Path

    Holds a more details version of a path information. This object is readonly

    ToManyRelationship

    Class holding references to multiple items of the same collection that can be loaded or not.

    ToOneRelationship

    Class holding a reference to an item that can be loaded or not

    Interfaces

    FirestoreDate

    Interface for the representation of a date in a firestore document

    IFirestormModel

    Minimal requirements for a firestorm model

    IMandatoryFirestormModel

    Requirements for a firestorm model that is referenced

    PropertyBluePrint

    Describes how a property of a model is gonna be turned in a document.

    RelationshipMetadata

    Relationship metadata. A relationship is a link from the current document to other documents.

    SubCollectionMetadatas

    Metadatas specific to a subcollection

    SubDocumentMetadatas

    Metadatas specific to a subdocument

    ToCollectionRelationshipMetadata

    Relationship metadata. A relationship is a link from the current document to other documents.

    ToDocumentRelationshipMetadata

    Relationship metadata. A relationship is a link from the current document to other documents.

    ToManyRelationshipMetadata

    To-many relationship metadatas

    ToOneRelationshipMetadata

    To-one relationship metadatas

    Type

    Newable function of T

    Type Aliases

    CollectionOfModels

    Type that is representing a collection of multiple models

    DocumentToModelConverter

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

    DocumentToModelFieldConverter

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

    FirestoreDocument

    Type for a firestore document

    FirestoreDocumentField

    Field types in a firestore document

    FirestoreFieldBaseType

    Base field types in a firestore document

    FirestoreFieldCompositeType

    Composite field types in a firestore document (built using other documents)

    FirestormId

    Type of a Firestorm Id

    FirestormModel

    Alias of IFirestormModel

    FirestormPropertyMetadataWithRelationship

    Specialized type of FirestormPropertyMetadata that has a relationship

    ForwardRef

    Used to delay when a type is retrieved, mostly to solve cyclic dependencies

    ForwardRefAction

    Action performed on a type

    IdModelDictionary

    Dictionary of id and model corresponding to this id

    MandatoryFirestormModel
    ModelToDocumentConverter

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

    ModelToDocumentFieldConverter

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

    PathLike

    Objects that can represent a path

    RelationshipKind

    Kind of relationship

    RelationshipLocation

    Where to find the referenced document

    StringArrayField

    Array containing strings

    SubscribeFunction

    Type alias for observable's first parameter

    ToCollectionRelationship

    The type of the property associated with a ToCollection decorator.

    ToDocumentRelationship

    The type of the property associated with a ToDocument decorator.

    TransactionFnc

    Type for functions passed to firebase's runTransaction

    Variables

    OR_QUERIES_MAXIMUM_DISJONCTIONS

    The maximum amount of disjonctions in the query's disjunctive normal form.

    SpecialSegments

    Special path segments

    TRANSACTION_MAX_OPERATION_PER_DOCUMENT

    The limit of modifications on a document per transaction

    Type

    Describes a function that can generate an object

    Functions

    buildPath

    Builds a path object by agregating a collection of segments

    coerceToListOfModels

    Coerces a collection of models into being a list of models

    coerceToPath

    Converts the given object to path.

    dateFromFirestoreDate

    Converts a firestore date to a JS date

    distinctWithKey

    Removes the duplicates in an array.

    groupBy

    Splits the array into subgroups

    hasFieldOfType

    Checks if the given host object has a property or field with a given name containing an value of a given type

    isCollectionRelationshipMetadata

    Duck types metadata to check if it's a ToCollectionRelationshipMetadata

    isDocumentRelationshipMetadata

    Duck types metadata to check if it's a ToDocumentRelationshipMetadata

    isFirestoreDate

    Duck types if the object is a firestore date

    isIn

    Duck types an object by checking if it has a field named fieldName

    isStringArrayField

    Check if the value is an array with strings. It verifies every single item in the array

    isToManyRelationshipMetadata

    Duck types metadata to check if it's a ToManyRelationshipMetadata

    isToOneRelationshipMetadata

    Duck types metadata to check if it's a ToOneRelationshipMetadata

    logError

    Logs error message in firestorm

    logInfo

    Logs information messages in firestorm

    logWarn

    Logs warning messages in firestorm

    modelListToIdModelDictionary

    Converts a list of models with ids into a IdModelDictionary of these models

    pascalToSnakeCase

    Converts a string in pascal or camel case to a string in snake case

    resolveId

    Take a firestorm model or an id and gets the id

    resolveInstance

    Take an instance of a model or an id and gets an instance

    splitInBatches

    Splits the array in smallers arrays of a specific maximum size.

    stringSingularToPlural

    Transforms a singular string in a plural string

    toSegments

    Split the path into segments