Type Alias: RelatedModelRelationOptions<RelatedModel>

type RelatedModelRelationOptions<RelatedModel> =
  | RelationOptions<RelatedModel, LucidModel, HasOne<RelatedModel, LucidModel>>
  | ManyToManyRelationOptions<ManyToMany<RelatedModel>>
  | Omit<
      ThroughRelationOptions<
        RelatedModel,
        LucidModel,
        HasManyThrough<RelatedModel>
      >,
      "throughModel"
    >;

Options for relation decorators on related models.

Type Parameters

Type Parameter
RelatedModel extends LucidModel

Example

import { resourcefulBelongsTo } from "@nhtio/lucid-resourceful";

class Post {
  @resourcefulBelongsTo(() => User, { foreignKey: "user_id" })
  public user: User;
}