API Reference Source
public class | source

HasMany

Extends:

Association → HasMany

One-to-many association

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().

See:

Method Summary

Public Methods
public

async add(sourceInstance: Model, targetInstances: Model | Model[] | string[] | string | number[] | number, options: object): Promise

Associate one or more target rows with this.

public

async count(instance: Model, options: object): Promise<number>

Count everything currently associated with this, using an optional where clause.

public

async create(sourceInstance: Model, values: object, options: object): Promise

Create a new instance of the associated model and associate it with this.

public

async get(instances: Model | Array<Model>, options: object): Promise<Array<Model>>

Get everything currently associated with this, using an optional where clause.

public

async has(sourceInstance: Model, targetInstances: Model | Model[] | string[] | string | number[] | number, options: object): Promise

Check if one or more rows are associated with this.

public

async remove(sourceInstance: Model, targetInstances: Model | Model[] | string | string[] | number | number[], options: object): Promise

Un-associate one or several target rows.

public

async set(sourceInstance: Model, targetInstances: Model | Model[] | string[] | string | number[] | number, options: object): Promise

Set the associated models by passing an array of persisted instances or their primary keys.

Inherited Summary

From class Association
public

The type of the association.

public
public

Public Methods

public async add(sourceInstance: Model, targetInstances: Model | Model[] | string[] | string | number[] | number, options: object): Promise source

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.

Params:

NameTypeAttributeDescription
sourceInstance Model

the source instance

targetInstances Model | Model[] | string[] | string | number[] | number
  • optional

A single instance or primary key, or a mixed array of persisted instances or primary keys

options object
  • optional

Options passed to target.update.

Return:

Promise

public async count(instance: Model, options: object): Promise<number> source

Count everything currently associated with this, using an optional where clause.

Params:

NameTypeAttributeDescription
instance Model

the source instance

options object
  • optional

find & count options

options.where object
  • optional

An optional where clause to limit the associated models

options.scope string | boolean
  • optional

Apply a scope on the related model, or remove its default scope by passing false

Return:

Promise<number>

public async create(sourceInstance: Model, values: object, options: object): Promise source

Create a new instance of the associated model and associate it with this.

Params:

NameTypeAttributeDescription
sourceInstance Model

source instance

values object
  • optional

values for target model instance

options object
  • optional

Options passed to target.create

Return:

Promise

public async get(instances: Model | Array<Model>, options: object): Promise<Array<Model>> source

Get everything currently associated with this, using an optional where clause.

Params:

NameTypeAttributeDescription
instances Model | Array<Model>

source instances

options object
  • optional

find options

options.where object
  • optional

An optional where clause to limit the associated models

options.scope string | boolean
  • optional

Apply a scope on the related model, or remove its default scope by passing false

options.schema string
  • optional

Apply a schema on the related model

Return:

Promise<Array<Model>>

See:

public async has(sourceInstance: Model, targetInstances: Model | Model[] | string[] | string | number[] | number, options: object): Promise source

Check if one or more rows are associated with this.

Params:

NameTypeAttributeDescription
sourceInstance Model

the source instance

targetInstances Model | Model[] | string[] | string | number[] | number
  • optional

Can be an array of instances or their primary keys

options object
  • optional

Options passed to getAssociations

Return:

Promise

public async remove(sourceInstance: Model, targetInstances: Model | Model[] | string | string[] | number | number[], options: object): Promise source

Un-associate one or several target rows.

Params:

NameTypeAttributeDescription
sourceInstance Model

instance to un associate instances with

targetInstances Model | Model[] | string | string[] | number | number[]
  • optional

Can be an Instance or its primary key, or a mixed array of instances and primary keys

options object
  • optional

Options passed to target.update

Return:

Promise

public async set(sourceInstance: Model, targetInstances: Model | Model[] | string[] | string | number[] | number, options: object): Promise source

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

Params:

NameTypeAttributeDescription
sourceInstance Model

source instance to associate new instances with

targetInstances Model | Model[] | string[] | string | number[] | number
  • optional

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

options object
  • optional

Options passed to target.findAll and update.

options.validate object
  • optional

Run validation for the join model

Return:

Promise