Interface RelatorOptions<PrimaryType, RelatedType>

interface RelatorOptions<PrimaryType, RelatedType> {
    linkers: {
        related?: Linker<[PrimaryType, nullish | SingleOrArray<RelatedType>]>;
        relationship?: Linker<[PrimaryType, nullish | SingleOrArray<RelatedType>]>;
    };
    metaizer?: Metaizer<[PrimaryType, nullish | SingleOrArray<RelatedType>]>;
    relatedName?: string;
}

Type Parameters

PrimaryType
RelatedType extends Dictionary<any> = any

Index

Properties

linkers metaizer? relatedName?

Properties

linkers

linkers: {
related?: Linker<[PrimaryType, nullish | SingleOrArray<RelatedType>]>;
relationship?: Linker<[PrimaryType, nullish | SingleOrArray<RelatedType>]>;
}

A dictionary of Linkers to use for constructing links.

Type declaration

Optional related?: Linker<[PrimaryType, nullish | SingleOrArray<RelatedType>]>
A Linker that gets the related link between the primary data and the (array of) related data.
Optional relationship?: Linker<[PrimaryType, nullish | SingleOrArray<RelatedType>]>
A Linker that gets the self link between the primary data and the (array of) related data.

See

Resource object relationships for more information.

`Optional` metaizer

metaizer?: Metaizer<[PrimaryType, nullish | SingleOrArray<RelatedType>]>

A Metaizer that gets the meta about the relationship.

`Optional` relatedName

relatedName?: string

Generated using TypeDoc