Class ToOneRelationship<T_target>

constructor

• new ToOneRelationship<T_target extends IFirestormModel>(
      type: Type<T_target>,
      id?: string,
  ): ToOneRelationship<T_target>

  Creates a ToOneRelationship

  Type Parameters

  • T_target extends IFirestormModel

  Parameters

  • type: Type<T_target>

    Type of the model

  • Optionalid: string

    Id of the linked model

  Returns ToOneRelationship<T_target>

Readonlytype

id

• get id(): string | null

  Gets the id of the document for this relationship.

  Returns string | null

• set id(newId: string | null | undefined): void

  Sets the id for this relation.

  If there is a model already loaded and the newid makes the relationship invalid, it will remove the model aswell.

  Parameters

  • newId: string | null | undefined

    Id to assign.

  Returns void

invalid

• get invalid(): boolean

  Whether or not the id and the model are mismatched.

  Returns boolean

  See

  valid

model

• get model(): T_target | undefined

  The loaded model

  Returns T_target | undefined

modelIfValid

• get modelIfValid(): T_target | undefined

  Gets the model if it is validated against the id, or undefined otherwise.

  Returns T_target | undefined

valid

• get valid(): boolean

  Whether or not the id and the model match.

  If the id is falsy, the value must be falsy too to be valid. If there is an id, then the model must be loaded and have the same id.

  Returns boolean

setModel

• setModel(model: T_target): void

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

  It will update the id of the relationship.

  Parameters

  • model: T_target

    Model to set

  Returns void