import Linker from '../classes/linker'; import Metaizer from '../classes/metaizer'; import { Dictionary, nullish, SingleOrArray } from '../types/global.types'; export interface RelatorOptions = any> { /** * A dictionary of {@link Linker}s to use for constructing links. * * @see {@link https://jsonapi.org/format/#document-resource-object-relationships | Resource object relationships} for more information. */ linkers: { /** * A {@link Linker} that gets the [self link](https://jsonapi.org/format/#document-resource-object-relationships) * between the primary data and the (array of) related data. */ relationship?: Linker<[PrimaryType, SingleOrArray | nullish]>; /** * A {@link Linker} that gets the [related link](https://jsonapi.org/format/#document-resource-object-relationships) * between the primary data and the (array of) related data. */ related?: Linker<[PrimaryType, SingleOrArray | nullish]>; }; /** * A {@link Metaizer} that gets the * [meta](https://jsonapi.org/format/#document-resource-object-relationships) * about the relationship. */ metaizer?: Metaizer<[PrimaryType, SingleOrArray | nullish]>; relatedName?: string; } //# sourceMappingURL=relator.interface.d.ts.map