Type alias BelongsToManyRemoveAssociationsMixin<TModel, TModelPrimaryKey>

Type declaration

• • (associationsToRemove?: (TModel | TModelPrimaryKey)[], options?: BelongsToManyRemoveAssociationsMixinOptions): Promise<void>

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

    class User extends Model<InferAttributes<User>, InferCreationAttributes<User>> {
      declare removeRoles: BelongsToManyRemoveAssociationsMixin<Role, Role['id']>;
    }
    
    User.belongsToMany(Role, { through: UserRole });
    

    See

    Model.belongsToMany

    Parameters

    • Optional associationsToRemove: (TModel | TModelPrimaryKey)[]

    • Optional options: BelongsToManyRemoveAssociationsMixinOptions

    Returns Promise<void>