Type alias BelongsToManyAddAssociationMixin<T, TModelPrimaryKey>

BelongsToManyAddAssociationMixin<T, TModelPrimaryKey>: ((newAssociation?, options?) => Promise<void>)

The addAssociation mixin applied to models with belongsToMany. An example of usage is as follows:

class User extends Model<InferAttributes<User>, InferCreationAttributes<User>> {
  declare addRole: BelongsToManyAddAssociationMixin<Role, Role['id']>;
}

User.belongsToMany(Role, { through: UserRole });

Type Parameters

T extends Model
TModelPrimaryKey

Type declaration

- (newAssociation?, options?): Promise<void>
- Parameters
  - Optional newAssociation: T | TModelPrimaryKey
  - Optional options: BelongsToManyAddAssociationMixinOptions<T>
  Returns Promise<void>

See

Model.belongsToMany