Type alias BelongsToManyAddAssociationsMixin<T, TModelPrimaryKey>

BelongsToManyAddAssociationsMixin<T, TModelPrimaryKey>: ((newAssociations?, options?) => Promise<void>)

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

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

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

Type Parameters

T extends Model
TModelPrimaryKey

Type declaration

- (newAssociations?, options?): Promise<void>
- Parameters
  - Optional newAssociations: Iterable<T | TModelPrimaryKey>
  - Optional options: BelongsToManyAddAssociationsMixinOptions<T>
  Returns Promise<void>

See

Model.belongsToMany