Class BelongsToManyAssociation<TCreationAttributes, TModelAttributes, TCreationAttributesThrough, TModelAttributesThrough>

Type Parameters

TCreationAttributes extends {}
TModelAttributes extends {}
TCreationAttributesThrough extends {}
TModelAttributesThrough extends {}

Hierarchy

BaseAssociation<TCreationAttributes, TModelAttributes>
- BelongsToManyAssociation

Index

Constructors

constructor

new BelongsToManyAssociation<TCreationAttributes, TModelAttributes, TCreationAttributesThrough, TModelAttributesThrough>(associatedClassGetter, options): BelongsToManyAssociation<TCreationAttributes, TModelAttributes, TCreationAttributesThrough, TModelAttributesThrough>
Type Parameters
- TCreationAttributes extends {}
- TModelAttributes extends {}
- TCreationAttributesThrough extends {}
- TModelAttributesThrough extends {}
Parameters
- associatedClassGetter: ModelClassGetter<TCreationAttributes, TModelAttributes>
- options: BelongsToManyOptions<TCreationAttributesThrough, TModelAttributesThrough>
Returns BelongsToManyAssociation<TCreationAttributes, TModelAttributes, TCreationAttributesThrough, TModelAttributesThrough>
Overrides BaseAssociation.constructor
- Defined in packages/@biorate/sequelize/node_modules/sequelize-typescript/dist/associations/belongs-to-many/belongs-to-many-association.d.ts:10

Properties

`Private` getThroughOptions

getThroughOptions: any

`Protected` options

options: BelongsToManyOptions<TCreationAttributesThrough, TModelAttributesThrough>

Methods

getAs

getAs(): string | {
plural: string;
singular: string;
}
Returns string | {
plural: string;
singular: string;
}
Inherited from BaseAssociation.getAs
- Defined in packages/@biorate/sequelize/node_modules/sequelize-typescript/dist/associations/shared/base-association.d.ts:13

getAssociatedClass

getAssociatedClass(): ModelType<TCreationAttributes, TModelAttributes>
Returns ModelType<TCreationAttributes, TModelAttributes>
Inherited from BaseAssociation.getAssociatedClass
- Defined in packages/@biorate/sequelize/node_modules/sequelize-typescript/dist/associations/shared/base-association.d.ts:12

getAssociation

getAssociation(): Association
Returns Association
Overrides BaseAssociation.getAssociation
- Defined in packages/@biorate/sequelize/node_modules/sequelize-typescript/dist/associations/belongs-to-many/belongs-to-many-association.d.ts:11

getSequelizeOptions

getSequelizeOptions(model, sequelize): UnionAssociationOptions
Parameters
- model: ModelType<TCreationAttributes, TModelAttributes>
- sequelize: Sequelize
Returns UnionAssociationOptions
Overrides BaseAssociation.getSequelizeOptions
- Defined in packages/@biorate/sequelize/node_modules/sequelize-typescript/dist/associations/belongs-to-many/belongs-to-many-association.d.ts:12

Class BelongsToManyAssociation<TCreationAttributes, TModelAttributes, TCreationAttributesThrough, TModelAttributesThrough>

Type Parameters

TCreationAttributes extends {}

TModelAttributes extends {}

TCreationAttributesThrough extends {}

TModelAttributesThrough extends {}

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TCreationAttributes extends {}

TModelAttributes extends {}

TCreationAttributesThrough extends {}

TModelAttributesThrough extends {}

Parameters

associatedClassGetter: ModelClassGetter<TCreationAttributes, TModelAttributes>

options: BelongsToManyOptions<TCreationAttributesThrough, TModelAttributesThrough>

Returns BelongsToManyAssociation<TCreationAttributes, TModelAttributes, TCreationAttributesThrough, TModelAttributesThrough>

Properties

Private getThroughOptions

Protected options

Methods

getAs

Returns string | { plural: string; singular: string; }

getAssociatedClass

Returns ModelType<TCreationAttributes, TModelAttributes>

getAssociation

Returns Association

getSequelizeOptions

Parameters

model: ModelType<TCreationAttributes, TModelAttributes>

sequelize: Sequelize

Returns UnionAssociationOptions

Settings

Member Visibility

Theme

On This Page

`Private` getThroughOptions

`Protected` options

Returns string | {
plural: string;
singular: string;
}