Interface BelongsToOptions
Defined in: fields/belongs-to.ts:10
Options accepted by the belongsTo decorator.
Properties
as?
optional as?: string;Defined in: fields/belongs-to.ts:49
If this field is polymorphic, the trait or abstract type that this resource implements.
async?
optional async?: boolean;Defined in: fields/belongs-to.ts:32
Whether the relationship is async. Compiles onto the LegacyBelongsToField's options.async, defaulting to false.
inverse
inverse: string | null;Defined in: fields/belongs-to.ts:24
The name of the inverse field on the related resource, or null if the relationship is unidirectional.
polymorphic?
optional polymorphic?: boolean;Defined in: fields/belongs-to.ts:41
Whether this field satisfies a polymorphic relationship on another resource, meaning it can point to multiple types of resources so long as they implement the trait or abstract type named by type.
sourceKey?
optional sourceKey?: string;Defined in: fields/belongs-to.ts:57
The name of the field as returned by the API, if it differs from the decorated property's name.
type
type: string;Defined in: fields/belongs-to.ts:16
The name of the related resource's type.