Class FirestormPropertyMetadata<T_property_type>

constructor

• new FirestormPropertyMetadata<T_property_type = any>(
      name: string,
  ): FirestormPropertyMetadata<T_property_type>

  Creates a new property metadata

  Type Parameters

  • T_property_type = any

  Parameters

  • name: string

    Name of property

  Returns FirestormPropertyMetadata<T_property_type>

ignored

OptionalmappedTo

Readonlyname

defaultDocumentFieldName

• get defaultDocumentFieldName(): string

  Gets the default document field matched with this property

  Returns string

documentFieldName

• get documentFieldName(): string

  Field in the document mapped to this property

  Returns string

hasConversion

• get hasConversion(): boolean

  Checks the existency of a model-to-document or document-to-model conversion for this property

  Returns boolean

hasConversionToDocument

• get hasConversionToDocument(): boolean

  Checks the existency of a model to document conversion for this property

  Returns boolean

  True if a conversion exists, false otherwise.

hasConversionToModel

• get hasConversionToModel(): boolean

  Checks the existency of a document to model conversion for this property

  Returns boolean

  True if a conversion exists, false otherwise.

relationship

• get relationship(): RelationshipMetadata<IFirestormModel> | undefined

  Gets the relationship this field covers if any

  Returns RelationshipMetadata<IFirestormModel> | undefined

• set relationship(value: RelationshipMetadata<IFirestormModel> | undefined): void

  Sets the relationship this field covers

  Parameters

  • value: RelationshipMetadata<IFirestormModel> | undefined

    New value of the relationship

  Returns void

toDocumentConverter

• get toDocumentConverter(): ModelToDocumentFieldConverter<T_property_type>

  Gets the conversion from model to document

  Returns ModelToDocumentFieldConverter<T_property_type>

• set toDocumentConverter(
      value: ModelToDocumentFieldConverter<T_property_type>,
  ): void

  Sets the conversion from model to document

  Parameters

  • value: ModelToDocumentFieldConverter<T_property_type>

    Converter to set

  Returns void

toModelConverter

• get toModelConverter(): DocumentToModelFieldConverter<T_property_type>

  Gets the conversion from document to model

  Returns DocumentToModelFieldConverter<T_property_type>

• set toModelConverter(
      value: DocumentToModelFieldConverter<T_property_type>,
  ): void

  Sets the conversion from document to model

  Parameters

  • value: DocumentToModelFieldConverter<T_property_type>

    Converter to set

  Returns void

setToCollectionRelationship

• setToCollectionRelationship<T_target_model extends IFirestormModel>(
      targetType: Type<T_target_model>,
      location: PathLike,
  ): void

  Sets this field as being a Collection relationship

  Type Parameters

  • T_target_model extends IFirestormModel

    Type of the target model

  Parameters

  • targetType: Type<T_target_model>

    Type of the target

  • location: PathLike

    Location of target

  Returns void

setToDocumentRelationship

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

  Sets this field as being a Document relationship

  Type Parameters

  • T_target_model extends IFirestormModel

    Type of the target model

  Parameters

  • targetType: Type<T_target_model>

    Type of the target

  • location: PathLike

    Location of target

  • documentId: string

    The id of the document to link

  Returns void

setToManyRelationship

• setToManyRelationship<T_target_model extends IFirestormModel>(
      targetType: Type<T_target_model>,
      location: PathLike,
  ): void

  Sets this field as being a ToMany relationship

  Type Parameters

  • T_target_model extends IFirestormModel

    Type of the target model

  Parameters

  • targetType: Type<T_target_model>

    Type of the target

  • location: PathLike

    Location of target

  Returns void

setToOneRelationship

• setToOneRelationship<T_target_model extends IFirestormModel>(
      targetType: Type<T_target_model>,
      location: PathLike,
  ): void

  Sets this field as being a ToOne relationship.

  Type Parameters

  • T_target_model extends IFirestormModel

    Type of the target model

  Parameters

  • targetType: Type<T_target_model>

    Type of the target

  • location: PathLike

    Location of target

  Returns void