Class RelationshipMetadata

constructor

• new RelationshipMetadata(Entity: TableType, mapTo: string, to: function, on: function, cardinality: CardinalityType): RelationshipMetadata

• Initialize the relationship metadata.

  Parameters

  • Entity: TableType

    The type (constructor) of the table where this relationship was defined.

  • mapTo: string

    The property in Entity on which this relationship was defined.

  • to: function

    A function that, when called, returns the referenced Entity type (constructor).

    • • (): TableType

      • Returns TableType

  • on: function

    A function that, when called, returns an array consisting of the names of the local and remote properties. E.g. (user, phoneNumber) => [user.id, phoneNumber.userID] (returns ['userID', 'phoneNumberID']). The function will be passed PropertyMapTypes containing all the decorated properties of Entity and RefEntity. If the relationship between Entity and RefEntity depends on multiple columns, then an array of arrays should be returned.

    • • (entity: PropertyMapType, refEntity: PropertyMapType): string[] | string[][]

      • Parameters

        • entity: PropertyMapType

        • refEntity: PropertyMapType

        Returns string[] | string[][]

  • cardinality: CardinalityType

    The relationship type (e.g. OneToMany).

  Returns RelationshipMetadata