Function Attach

belongs to many custom pivot

const john = await FedacoTestUserWithCustomFriendPivot
  .createQuery()
  .create({
    id: 1,
    name: 'John Doe',
    email: 'johndoe@example.com'
  });
const jane = await FedacoTestUserWithCustomFriendPivot
  .createQuery()
  .create({
    id: 2,
    name: 'Jane Doe',
    email: 'janedoe@example.com'
  });
const jack = await FedacoTestUserWithCustomFriendPivot
  .createQuery()
  .create({
    id: 3,
    name: 'Jack Doe',
    email: 'jackdoe@example.com'
  });
const jule = await FedacoTestUserWithCustomFriendPivot
  .createQuery()
  .create({
    id: 4,
    name: 'Jule Doe',
    email: 'juledoe@example.com'
  });
await FedacoTestFriendLevel.createQuery().create({
  id: 1,
  level: 'acquaintance'
});
await FedacoTestFriendLevel.createQuery().create({
  id: 2,
  level: 'friend'
});
await FedacoTestFriendLevel.createQuery().create({
  id: 3,
  level: 'bff'
});
await john.NewRelation('friends').attach(jane, {
  friend_level_id: 1
});
await john.NewRelation('friends').attach(jack, {
  friend_level_id: 2
});
await john.NewRelation('friends').attach(jule, {
  friend_level_id: 3
});
const johnWithFriends = await FedacoTestUserWithCustomFriendPivot.createQuery()
  .with('friends')
  .find(1);

Reference	Looks Like	Value
await (await johnWithFriends.friends.find(it => it.id === 3).getAttribute( 'pivot').level).level	exactly match	'friend'
(await johnWithFriends.friends.find(it => it.id === 4).getAttribute( 'pivot').friend).name	exactly match	'Jule Doe'

---

see also prerequisites