polymorphism

Polymorphism enables you to specify more than one model class for the same association slot, like so:

// models/Pet.ts
export default class Rating extends Dream {
  @deco.BelongsTo(['User', 'Recipe', 'Organization'], { polymorphic: true })
  public rateable: User | Recipe | Organization
  public rateableId: DreamColumn<Rating, 'rateableId'>
  public rateableType: DreamColumn<Rating, 'rateableType'>
}

In the above case, Dream will automatically set the class name of the model to the ratingType any time you are saving a record to a polymorphic slot:

const rating = await Rating.create({ rateable: user })
console.log(rating.rateableId) // prints the user's id
console.log(rating.rateableType) // prints "User"

Additionally, any time the polymorphic slot is loaded, the data will be cast to the appropriate model

const ratings = await Rating.preload('rateable').all()
console.log(ratings.map((rating) => rating.rateable))
// [User{}, Recipe{}, User{}, Organization{}, etc...]