Class HasManyAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>

One-to-many association. See Model.hasMany

Like with HasOneAssociation, the foreign key will be defined on the target model.

In the API reference below, add the name of the association to the method, e.g. for User.hasMany(Project) the getter will be user.getProjects(). If the association is aliased, use the alias instead, e.g. User.hasMany(Project, { as: 'jobs' }) will be user.getJobs().

Type Parameters

S extends Model = Model
The model on which Model.hasMany has been called, on which the association methods will be added.
T extends Model = Model
The model passed to Model.hasMany. This model will receive the Foreign Key attribute.
SourceKey extends AttributeNames<S> = AttributeNames<S>
The name of the attribute that the foreign key in the target model will reference.
TargetKey extends AttributeNames<T> = AttributeNames<T>
The name of the Foreign Key attribute on the Target model.
TargetPrimaryKey extends AttributeNames<T> = AttributeNames<T>
The name of the Primary Key attribute of the Target model. Used by HasManySetAssociationsMixin & others.

Index

Constructors

constructor

new HasManyAssociation<
    S extends Model<any, any> = Model<any, any>,
    T extends Model<any, any> = Model<any, any>,
    SourceKey extends string = AttributeNames<S>,
    TargetKey extends string = AttributeNames<T>,
    TargetPrimaryKey extends string = AttributeNames<T>,
>(
    secret: symbol,
    source: ModelStatic<S>,
    target: ModelStatic<T>,
    options: NormalizedHasManyOptions<SourceKey, TargetKey>,
    parent?: Association<
        Model<any, any>,
        Model<any, any>,
        string,
        NormalizedAssociationOptions<string>,
    >,
    inverse?: BelongsToAssociation<T, S, TargetKey, SourceKey>,
): HasManyAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>
Type Parameters
- S extends Model<any, any> = Model<any, any>
  The model on which Model.hasMany has been called, on which the association methods will be added.
- T extends Model<any, any> = Model<any, any>
  The model passed to Model.hasMany. This model will receive the Foreign Key attribute.
- SourceKey extends string = AttributeNames<S>
  The name of the attribute that the foreign key in the target model will reference.
- TargetKey extends string = AttributeNames<T>
  The name of the Foreign Key attribute on the Target model.
- TargetPrimaryKey extends string = AttributeNames<T>
  The name of the Primary Key attribute of the Target model. Used by HasManySetAssociationsMixin & others.
Parameters
- secret: symbol
- source: ModelStatic<S>
- target: ModelStatic<T>
- options: NormalizedHasManyOptions<SourceKey, TargetKey>
- Optionalparent: Association<
      Model<any, any>,
      Model<any, any>,
      string,
      NormalizedAssociationOptions<string>,
  >
- Optionalinverse: BelongsToAssociation<T, S, TargetKey, SourceKey>
Returns HasManyAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>
Overrides MultiAssociation<S, T, TargetKey, TargetPrimaryKey, NormalizedHasManyOptions<SourceKey, TargetKey>>.constructor
- Defined in core/lib/associations/has-many.d.ts:43

Properties

accessors

accessors: MultiAssociationAccessors

`Readonly`inverse

inverse: BelongsToAssociation<T, S, TargetKey, SourceKey>

isAliased

isAliased: boolean

isSelfAssociation

isSelfAssociation: boolean

`Readonly`options

options: NormalizedHasManyOptions

`Readonly`parentAssociation

parentAssociation:
    | Association<
        Model<any, any>,
        Model<any, any>,
        string,
        NormalizedAssociationOptions<string>,
    >
    | null

A reference to the association that created this one.

source

source: ModelStatic<S>

target

target: ModelStatic<T>

Accessors

as

get as(): string
The identifier of the relation on the source model.

Returns string
Inherited from <internal>.as
- Defined in core/lib/associations/base.d.ts:117

associationType

get associationType(): string
The type of the association. One of HasMany, BelongsTo, HasOne, BelongsToMany

Returns string
Inherited from <internal>.associationType
- Defined in core/lib/associations/base.d.ts:106

foreignKey

get foreignKey(): TargetKey
The name of the foreign key attribute used by this association.

Returns TargetKey
Overrides <internal>.foreignKey
- Defined in core/lib/associations/has-many.d.ts:25

identifierField

get identifierField(): string
The column name of the foreign key (on the target model)

Returns string
- Defined in core/lib/associations/has-many.d.ts:29

isMultiAssociation

get isMultiAssociation(): boolean
Returns boolean
Inherited from <internal>.isMultiAssociation
- Defined in core/lib/associations/base.d.ts:107

isSingleAssociation

get isSingleAssociation(): boolean
Returns boolean

Deprecated
negate isMultiAssociation instead
Inherited from <internal>.isSingleAssociation
- Defined in core/lib/associations/base.d.ts:111

name

get name(): { plural: string; singular: string }
Returns { plural: string; singular: string }
Inherited from <internal>.name
- Defined in core/lib/associations/base.d.ts:118

rootAssociation

get rootAssociation(): Association
Creating an associations can automatically create other associations. This returns the initial association that caused the creation of the descendant associations.

Returns Association
Inherited from <internal>.rootAssociation
- Defined in core/lib/associations/base.d.ts:100

scope

get scope(): AssociationScope | undefined
Returns AssociationScope | undefined
Inherited from <internal>.scope
- Defined in core/lib/associations/base.d.ts:122

sourceKey

get sourceKey(): SourceKey
The name of the attribute the foreign key points to.

This key is on the Source Model. The Association.foreignKey is on the Target Model.

Returns SourceKey
- Defined in core/lib/associations/has-many.d.ts:36

sourceKeyAttribute

get sourceKeyAttribute(): SourceKey
Returns SourceKey

Deprecated
use sourceKey
- Defined in core/lib/associations/has-many.d.ts:40

sourceKeyField

get sourceKeyField(): string
Returns string
- Defined in core/lib/associations/has-many.d.ts:41

`Static`isMultiAssociation

get isMultiAssociation(): boolean
Returns boolean
Inherited from MultiAssociation.isMultiAssociation
- Defined in core/lib/associations/base.d.ts:128

Methods

add

add(
    sourceInstance: S,
    rawTargetInstances?: AllowIterable<T | Exclude<T[TargetPrimaryKey], any[]>>,
    options?: HasManyAddAssociationsMixinOptions<T>,
): Promise<void>
Associate one or more target rows with this. This method accepts a Model / string / number to associate a single row, or a mixed array of Model / string / numbers to associate multiple rows.
Parameters
- sourceInstance: S
  the source instance
- OptionalrawTargetInstances: AllowIterable<T | Exclude<T[TargetPrimaryKey], any[]>>
  A single instance or primary key, or a mixed array of persisted instances or primary keys
- Optionaloptions: HasManyAddAssociationsMixinOptions<T>
  Options passed to target.update.
Returns Promise<void>
- Defined in core/lib/associations/has-many.d.ts:84

count

count(
instance: S,
options?: HasManyCountAssociationsMixinOptions<T>,
): Promise<number>
Count everything currently associated with this, using an optional where clause.
Parameters
- instance: S
  the source instance
- Optionaloptions: HasManyCountAssociationsMixinOptions<T>
  find & count options
Returns Promise<number>
- Defined in core/lib/associations/has-many.d.ts:59

create

create(
    sourceInstance: S,
    values?: CreationAttributes<T>,
    options?: HasManyCreateAssociationMixinOptions<T> | (keyof Attributes<T>)[],
): Promise<T>
Create a new instance of the associated model and associate it with this.
Parameters
- sourceInstance: S
  source instance
- Optionalvalues: CreationAttributes<T>
  values for target model instance
- Optionaloptions: HasManyCreateAssociationMixinOptions<T> | (keyof Attributes<T>)[]
  Options passed to target.create
Returns Promise<T>
- Defined in core/lib/associations/has-many.d.ts:100

get

get(instances: S, options?: HasManyGetAssociationsMixinOptions<T>): Promise<T[]>
Get everything currently associated with this, using an optional where clause.
Parameters
- instances: S
  source instances
- Optionaloptions: HasManyGetAssociationsMixinOptions<T>
  find options
Returns Promise<T[]>
- Defined in core/lib/associations/has-many.d.ts:51
get(
instances: S[],
options?: HasManyGetAssociationsMixinOptions<T>,
): Promise<Map<any, T[]>>
Get everything currently associated with this, using an optional where clause.
Parameters
- instances: S[]
  source instances
- Optionaloptions: HasManyGetAssociationsMixinOptions<T>
  find options
Returns Promise<Map<any, T[]>>
- Defined in core/lib/associations/has-many.d.ts:52

has

has(
    sourceInstance: S,
    targets: AllowIterable<T | Exclude<T[TargetPrimaryKey], any[]>>,
    options?: HasManyHasAssociationsMixinOptions<T>,
): Promise<boolean>
Check if one or more rows are associated with this.
Parameters
- sourceInstance: S
  the source instance
- targets: AllowIterable<T | Exclude<T[TargetPrimaryKey], any[]>>
  A list of instances or their primary keys
- Optionaloptions: HasManyHasAssociationsMixinOptions<T>
  Options passed to getAssociations
Returns Promise<boolean>
- Defined in core/lib/associations/has-many.d.ts:67

remove

remove(
    sourceInstance: S,
    targets: AllowIterable<T | Exclude<T[TargetPrimaryKey], any[]>>,
    options?: HasManyRemoveAssociationsMixinOptions<T>,
): Promise<void>
Un-associate one or several target rows.
Parameters
- sourceInstance: S
  instance to un associate instances with
- targets: AllowIterable<T | Exclude<T[TargetPrimaryKey], any[]>>
  Can be an Instance or its primary key, or a mixed array of instances and primary keys
- Optionaloptions: HasManyRemoveAssociationsMixinOptions<T>
  Options passed to target.update
Returns Promise<void>
- Defined in core/lib/associations/has-many.d.ts:92

set

set(
    sourceInstance: S,
    targets: AllowIterable<T | Exclude<T[TargetPrimaryKey], any[]>> | null,
    options?: HasManySetAssociationsMixinOptions<T>,
): Promise<void>
Set the associated models by passing an array of persisted instances or their primary keys. Everything that is not in the passed array will be un-associated
Parameters
- sourceInstance: S
  source instance to associate new instances with
- targets: AllowIterable<T | Exclude<T[TargetPrimaryKey], any[]>> | null
  An array of persisted instances or primary key of instances to associate with this. Pass null to remove all associations.
- Optionaloptions: HasManySetAssociationsMixinOptions<T>
  Options passed to target.findAll and update.
Returns Promise<void>
- Defined in core/lib/associations/has-many.d.ts:75

`Protected`toInstanceOrPkArray

toInstanceOrPkArray(
input: Nullish | AllowIterable<T | Exclude<T[TargetPrimaryKey], any[]>>,
): (T | Exclude<T[TargetPrimaryKey], any[]>)[]
Parameters
- input: Nullish | AllowIterable<T | Exclude<T[TargetPrimaryKey], any[]>>
Returns (T | Exclude<T[TargetPrimaryKey], any[]>)[]
Inherited from BelongsToManyAssociation.toInstanceOrPkArray
- Defined in core/lib/associations/base.d.ts:129

`Static`associate

associate<
    S extends Model<any, any>,
    T extends Model<any, any>,
    SourceKey extends string,
    TargetKey extends string,
>(
    secret: symbol,
    source: ModelStatic<S>,
    target: ModelStatic<T>,
    options?: HasManyOptions<SourceKey, TargetKey>,
    parent?: Association<
        any,
        Model<any, any>,
        string,
        NormalizedAssociationOptions<string>,
    >,
    inverse?: BelongsToAssociation<T, S, TargetKey, SourceKey>,
): HasManyAssociation<S, T, SourceKey, TargetKey>
Type Parameters
- S extends Model<any, any>
- T extends Model<any, any>
- SourceKey extends string
- TargetKey extends string
Parameters
- secret: symbol
- source: ModelStatic<S>
- target: ModelStatic<T>
- Optionaloptions: HasManyOptions<SourceKey, TargetKey>
- Optionalparent: Association<any, Model<any, any>, string, NormalizedAssociationOptions<string>>
- Optionalinverse: BelongsToAssociation<T, S, TargetKey, SourceKey>
Returns HasManyAssociation<S, T, SourceKey, TargetKey>
- Defined in core/lib/associations/has-many.d.ts:44

Class HasManyAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns HasManyAssociation<S, T, SourceKey, TargetKey, TargetPrimaryKey>

Properties

accessors

Readonlyinverse

isAliased

isSelfAssociation

Readonlyoptions

ReadonlyparentAssociation

source

target

Accessors

as

Returns string

associationType

Returns string

foreignKey

Returns TargetKey

identifierField

Returns string

isMultiAssociation

Returns boolean

isSingleAssociation

Returns boolean

Deprecated

name

Returns { plural: string; singular: string }

rootAssociation

Returns Association

scope

Returns AssociationScope | undefined

sourceKey

Returns SourceKey

sourceKeyAttribute

Returns SourceKey

Deprecated

sourceKeyField

Returns string

StaticisMultiAssociation

Returns boolean

Methods

add

Parameters

Returns Promise<void>

count

Parameters

Returns Promise<number>

create

Parameters

Returns Promise<T>

get

Parameters

Returns Promise<T[]>

Parameters

Returns Promise<Map<any, T[]>>

has

Parameters

Returns Promise<boolean>

remove

Parameters

Returns Promise<void>

set

Parameters

Returns Promise<void>

ProtectedtoInstanceOrPkArray

Parameters

Returns (T | Exclude<T[TargetPrimaryKey], any[]>)[]

Staticassociate

Type Parameters

Parameters

`Readonly`inverse

`Readonly`options

`Readonly`parentAssociation

`Static`isMultiAssociation

`Protected`toInstanceOrPkArray

`Static`associate