Class ToManyRelationship<T_target>

constructor

• new ToManyRelationship<T_target extends IFirestormModel>(
      type: Type<T_target>,
  ): ToManyRelationship<T_target>

  Creates a new ToManyRelationship

  Type Parameters

  • T_target extends IFirestormModel

  Parameters

  • type: Type<T_target>

    The type of models this relationship holds.

  Returns ToManyRelationship<T_target>

Readonlytype

ids

• get ids(): string[]

  Gets the ids of the relationship.

  The ids are in order of insertion and is preserved in the document.

  Returns string[]

models

• get models(): T_target[]

  Gets the models currently in the relationship.

  If

  Returns T_target[]

uniqueIds

• get uniqueIds(): string[]

  Gets the unique ids of the relationship

  The ids are in order of insertion but the duplicates are removed

  Returns string[]

addId

• addId(id: string): ToManyRelationship<T_target>

  Adds the id of a document to the relationship

  Parameters

  • id: string

    The id to add

  Returns ToManyRelationship<T_target>

  this

addIds

• addIds(ids: Iterable<string>): ToManyRelationship<T_target>

  Adds multiple document ids to the relationship

  Parameters

  • ids: Iterable<string>

    The ids to add

  Returns ToManyRelationship<T_target>

  this

addModel

• addModel(model: T_target): ToManyRelationship<T_target>

  Adds a model to the relationship.

  It adds the model's id to the list of ids tracked by the relationship. If you want to assign a model without changing the list, use assignModel

  Parameters

  • model: T_target

    Model to add

  Returns ToManyRelationship<T_target>

  this

addModels

• addModels(models: Iterable<T_target>): ToManyRelationship<T_target>

  Adds multiple models to the relationship

  It adds the models' ids to the list of ids tracked by the relationship. If you want to assign the models without changing the list, use assignModels

  Parameters

  • models: Iterable<T_target>

    Models to add

  Returns ToManyRelationship<T_target>

  this

assignModel

• assignModel(model: T_target): ToManyRelationship<T_target>

  Assigns a model to the relationship if its id is tracked.

  It only assigns a model if this model's id is already in the list of tracked ids. If you want to add the model to the tracking, use addModel

  Parameters

  • model: T_target

    Model to assign

  Returns ToManyRelationship<T_target>

  this

assignModels

• assignModels(models: Iterable<T_target>): ToManyRelationship<T_target>

  Assigns models to the relationship if their ids are tracked.

  It only assigns a model if this model's id is already in the list of tracked ids. If you want to add the model to the tracking, use addModels

  Parameters

  • models: Iterable<T_target>

    Models to assign

  Returns ToManyRelationship<T_target>

  this

clear

• clear(): void

  Erase all the relationships stored

  Returns void

getById

• getById(id: string): T_target | undefined

  Gets a specific loaded item by its id

  Parameters

  • id: string

    Id of the item to retrieve

  Returns T_target | undefined

  The model if it exists or undefined if not loaded or not in the relationship at all.

setIds

• setIds(ids: string | Iterable<string, any, any>): ToManyRelationship<T_target>

  Clears the current relationship and loaded models and add the ids provided in their place

  Parameters

  • ids: string | Iterable<string, any, any>

    The ids to add

  Returns ToManyRelationship<T_target>

  this

setModels

• setModels(models: Iterable<T_target>): ToManyRelationship<T_target>

  Sets the models of the relationship. The models must have an id.

  It clears the relationship of any previous id tracking.

  Parameters

  • models: Iterable<T_target>

    Models to set

  Returns ToManyRelationship<T_target>