Class FirestormMetadata<T_model>

constructor

• new FirestormMetadata<T_model>(type: Type<T_model>): FirestormMetadata<T_model>

  Creates a FirestormMetadata

  Type Parameters

  • T_model

    Type this metadatas are for

  Parameters

  • type: Type<T_model>

    Type this metadatas are for

  Returns FirestormMetadata<T_model>

Optionalcollection

Readonlytype

documentBlueprint

• get documentBlueprint(): Record<string, PropertyBluePrint>

  Creates a blueprint of the document created by the model

  Returns Record<string, PropertyBluePrint>

  Deprecated

  ⚠️ Not ready

relationshipMetadatas

• get relationshipMetadatas(): FirestormPropertyMetadataWithRelationship[]

  Gets the metadatas of the property with relationship.

  Returns FirestormPropertyMetadataWithRelationship[]

addDocumentToModelConverter

• addDocumentToModelConverter<T>(
      propertyName: string,
      converter: DocumentToModelFieldConverter<T>,
  ): void

  Adds a converter for a field from the document to the model

  Type Parameters

  • T

  Parameters

  • propertyName: string

    The name of the property in the model

  • converter: DocumentToModelFieldConverter<T>

    Conversion function

  Returns void

addIgnoredProperty

• addIgnoredProperty(propertyName: string): void

  Marks a key as ignored when deserializing a document

  Parameters

  • propertyName: string

    The name of the property to ignore

  Returns void

addModelToDocumentConverter

• addModelToDocumentConverter<T>(
      propertyName: string,
      converter: ModelToDocumentFieldConverter<T>,
  ): void

  Adds a converter for a property from the model to the document

  Type Parameters

  • T

  Parameters

  • propertyName: string

    The name of the property in the model

  • converter: ModelToDocumentFieldConverter<T>

    Conversion function

  Returns void

addProperty

• addProperty(propertyName: string): string

  Marks a key in the model to be read when deserializing a document

  Parameters

  • propertyName: string

    They name of the property in the model

  Returns string

  The default key that will be used in the document

addPropertyRemapping

• addPropertyRemapping(propertyName: string, mapTo: string): void

  Overrides the key in a document mapping to a the key in the model

  Parameters

  • propertyName: string

    Key in the model

  • mapTo: string

    Matching key in the document

  Returns void

addToCollectionRelationship

• addToCollectionRelationship<T_target_model extends IFirestormModel>(
      propertyName: string,
      targetType: Type<T_target_model>,
      location: PathLike,
  ): void

  Adds a ToCollection relationship

  Type Parameters

  • T_target_model extends IFirestormModel

    Type of the target of the relationship

  Parameters

  • propertyName: string

    The name of the property that has a relationship

  • targetType: Type<T_target_model>

    Type of the target of the relationship

  • location: PathLike

    Location of the relationship

  Returns void

addToDocumentRelationship

• addToDocumentRelationship<T_target_model extends IFirestormModel>(
      propertyName: string,
      targetType: Type<T_target_model>,
      location: PathLike,
      documentId: string,
  ): void

  Adds a ToDocument relationship

  Type Parameters

  • T_target_model extends IFirestormModel

    Type of the target of the relationship

  Parameters

  • propertyName: string

    The name of the property that has a relationship

  • targetType: Type<T_target_model>

    Type of the target of the relationship

  • location: PathLike

    Location of the relationship

  • documentId: string

    Id of the document

  Returns void

addToManyRelationship

• addToManyRelationship<T_target_model extends IFirestormModel>(
      propertyName: string,
      targetType: Type<T_target_model>,
      location: PathLike,
  ): void

  Adds a ToMany relationship

  Type Parameters

  • T_target_model extends IFirestormModel

    Type of the target of the relationship

  Parameters

  • propertyName: string

    The name of the property that has a relationship

  • targetType: Type<T_target_model>

    Type of the target of the relationship

  • location: PathLike

    Location of the relationship

  Returns void

addToOneRelationship

• addToOneRelationship<T_target_model extends IFirestormModel>(
      propertyName: string,
      targetType: Type<T_target_model>,
      location: PathLike,
  ): void

  Adds a ToOne relationship

  Type Parameters

  • T_target_model extends IFirestormModel

    Type of the target of the relationship

  Parameters

  • propertyName: string

    The name of the property that has a relationship

  • targetType: Type<T_target_model>

    Type of the target of the relationship

  • location: PathLike

    Location of the relationship

  Returns void

convertDocumentToModel

• convertDocumentToModel(document: FirestoreDocument): T_model

  Converts a document to a model

  Parameters

  • document: FirestoreDocument

    Document to convert

  Returns T_model

  The model created from the document

convertModelToDocument

• convertModelToDocument(model: Partial<T_model>): FirestoreDocument

  Converts a model or part of a model to a document.

  Parameters

  • model: Partial<T_model>

    Model to convert

  Returns FirestoreDocument

  The document created from the model