Class Relator<PrimaryType, RelatedType>

constructor

• new Relator<PrimaryType, RelatedType>(fetch, serializer, options?): Relator<PrimaryType, RelatedType>

• Creates a Relator.

  Type Parameters

  • PrimaryType

  • RelatedType extends Dictionary<any> = any

  Parameters

  • fetch: ((data) => Promise<nullish | RelatedType | RelatedType[]>)

    Fetches related data from primary data.

    • • (data): Promise<nullish | RelatedType | RelatedType[]>

      • Parameters

        • data: PrimaryType

        Returns Promise<nullish | RelatedType | RelatedType[]>

  • serializer: Serializer<RelatedType>

    The Serializer to use for related data.

  • Optional options: Partial<RelatorOptions<PrimaryType, RelatedType>>

    Options for the relator.

  Returns Relator<PrimaryType, RelatedType>
• new Relator<PrimaryType, RelatedType>(fetch, serializer, options): Relator<PrimaryType, RelatedType>

• Creates a Relator.

  Type Parameters

  • PrimaryType

  • RelatedType extends Dictionary<any> = any

  Parameters

  • fetch: ((data) => Promise<nullish | RelatedType | RelatedType[]>)

    Fetches related data from primary data.

    • • (data): Promise<nullish | RelatedType | RelatedType[]>

      • Parameters

        • data: PrimaryType

        Returns Promise<nullish | RelatedType | RelatedType[]>

  • serializer: (() => Serializer<RelatedType>)

    A getter for the Serializer to use for related data.

    • • (): Serializer<RelatedType>

      • Returns Serializer<RelatedType>

  • options: Partial<RelatorOptions<PrimaryType, RelatedType>> & Required<Pick<RelatorOptions<PrimaryType, RelatedType>, "relatedName">>

    Options for the relator, a relatedName is required as it cannot always be loaded from the serializer.

  Returns Relator<PrimaryType, RelatedType>

Internal getRelatedData

relatedName

Static defaultOptions

getRelatedIdentifier

• getRelatedIdentifier(data, options?): default
• Internal

  Creates related identifiers

  Parameters

  • data: RelatedType

  • Optional options: SerializerOptions<RelatedType>

  Returns default

getRelatedLinks

• getRelatedLinks(data, relatedData): undefined | Dictionary<nullish | default>
• Internal

  Gets related links from primary data and related data

  Parameters

  • data: PrimaryType

  • relatedData: nullish | RelatedType | RelatedType[]

  Returns undefined | Dictionary<nullish | default>

getRelatedMeta

• getRelatedMeta(data, relatedData): undefined | default
• Internal

  Gets related meta from primary data and related data

  Parameters

  • data: PrimaryType

  • relatedData: nullish | RelatedType | RelatedType[]

  Returns undefined | default

getRelatedRelators

• getRelatedRelators(): undefined | Record<string, Relator<RelatedType, any>>
• Internal

  Gets related relators

  Returns undefined | Record<string, Relator<RelatedType, any>>

getRelatedResource

• getRelatedResource(data, options?, helpers?, relatorDataCache?): Promise<default<RelatedType>>
• Internal

  Creates related resources

  Parameters

  • data: RelatedType

  • Optional options: Partial<SerializerOptions<RelatedType>>

  • Optional helpers: Helpers<RelatedType>

  • Optional relatorDataCache: Map<Relator<any, any>, Dictionary<any>[]>

  Returns Promise<default<RelatedType>>

getRelationship

• getRelationship(data, relatedDataCache?): Promise<undefined | default>
• Internal

  Creates a Relationship.

  Parameters

  • data: PrimaryType

  • Optional relatedDataCache: Dictionary<any>[]

  Returns Promise<undefined | default>