Type alias BelongsToManySetAssociationsMixin<TModel, TModelPrimaryKey>

BelongsToManySetAssociationsMixin<TModel, TModelPrimaryKey>: ((newAssociations?, options?) => Promise<void>)

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

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

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

Type Parameters

TModel extends Model
TModelPrimaryKey

Type declaration

- (newAssociations?, options?): Promise<void>
- Parameters
  - Optional newAssociations: Iterable<TModel | TModelPrimaryKey> | null
  - Optional options: BelongsToManySetAssociationsMixinOptions<TModel>
  Returns Promise<void>

See

Model.belongsToMany