Interface BelongsToManySetAssociationsMixin<TInstance, TInstancePrimaryKey, TJoinTableAttributes>

Callable

• __call(newAssociations?: Array<TInstance | TInstancePrimaryKey>, options?: BelongsToManySetAssociationsMixinOptions | FindOptions | BulkCreateOptions | InstanceUpdateOptions | InstanceDestroyOptions | TJoinTableAttributes): Promise<void>

• Set the associated models by passing an array of instances or their primary keys. Everything that it not in the passed array will be un-associated.

  
  User.belongsToMany(Role, { through: UserRole });
  
  interface UserInstance extends Sequelize.Instance<UserInstance, UserAttributes>, UserAttributes {
     // getRoles...
     setRoles: Sequelize.BelongsToManySetAssociationsMixin<RoleInstance, RoleId, UserRoleAttributes>;
     // addRoles...
     // addRole...
     // createRole...
     // removeRole...
     // removeRoles...
     // hasRole...
     // hasRoles...
     // countRoles...
  }
  

  Parameters

  • Optional newAssociations: Array<TInstance | TInstancePrimaryKey>

    An array of instances or primary key of instances to associate with this. Pass null or undefined to remove all associations.

  • Optional options: BelongsToManySetAssociationsMixinOptions | FindOptions | BulkCreateOptions | InstanceUpdateOptions | InstanceDestroyOptions | TJoinTableAttributes

    The options passed to through.findAll, bulkCreate, update and destroy. Can also hold additional attributes for the join table.

  Returns Promise<void>