Interface MultiAssociationOptions<ForeignKey>

Options provided for many-to-many relationships

interface MultiAssociationOptions<ForeignKey> {
    as?: string | {
        plural: string;
        singular: string;
    foreignKey?: ForeignKey | ForeignKeyOptions<ForeignKey>;
    foreignKeyConstraints?: boolean;
    hooks?: boolean;
    scope?: AssociationScope;

Type Parameters

  • ForeignKey extends string

Hierarchy (view full)


as?: string | {
    plural: string;
    singular: string;

The alias of this model, in singular form. See also the name option passed to sequelize.define. If you create multiple associations between the same tables, you should provide an alias to be able to distinguish between them. If you provide an alias when creating the association, you should provide the same alias when eager loading and when getting associated models. Defaults to the singularized name of target

Type declaration

  • plural: string
  • singular: string

The configuration of the foreign key Attribute. See Sequelize#define or Model.init for more information about the syntax.

Using a string is equivalent to passing a ForeignKeyOptions object with the option set.

foreignKeyConstraints?: boolean

Should ON UPDATE, ON DELETE, and REFERENCES constraints be enabled on the foreign key.

hooks?: boolean

If false the applicable hooks will not be called. The default value depends on the context.



A key/value set that will be used for association create and find defaults on the target. (sqlite not supported for N:M)