我的书签
添加书签
移除书签Mixin HasMany
One-to-many association
In the API reference below, replace with the actual name of your association, e.g. for User.hasMany(Project) the getter will be user.getProjects().
Get everything currently associated with this, using an optional where clause.
Params:
setAssociations([newAssociations], [options]) -> Promise
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:
| Name | Type | Description |
|---|---|---|
| [newAssociations] | Array.<Instance | String | Number> | An array of persisted instances or primary key of instances to associate with this. Pass null or to remove all associations. |
| [options] | Object | Options passed to target.findAll and update. |
| [options.validate] | Object | Run validation for the join model |
addAssociations([newAssociations], [options]) -> Promise
Associate several persisted instances with this.
| Name | Type | Description |
|---|---|---|
| [newAssociations] | Array.<Instance | String | Number> | An array of persisted instances or primary key of instances to associate with this. |
| [options] | Object | Options passed to target.update. |
| [options.validate] | Object | Run validation for the join model. |
Associate a persisted instance with this.
Params:
createAssociation([values], [options]) -> Promise
Create a new instance of the associated model and associate it with this.
Params:
| Name | Type | Description |
|---|---|---|
| [values] | Object | |
| [options] | Object | Options passed to target.create. |
removeAssociation([oldAssociated], [options]) -> Promise
Un-associate the instance.
Params:
| Name | Type | Description |
|---|---|---|
| [oldAssociated] | Instance | String | Number | Can be an Instance or its primary key |
| [options] | Object | Options passed to target.update |
Params:
hasAssociation([instance], [options]) -> Promise
Check if an instance is associated with this.
Params:
| Name | Type | Description |
|---|---|---|
| [instance] | Instance | String | Number | Can be an Instance or its primary key |
| [options] | Object | Options passed to getAssociations |
hasAssociations([instances], [options]) -> Promise
Check if all instances are associated with this.
Params:
| Name | Type | Description |
|---|---|---|
| [instances] | Array.<Instance | String | Number> | Can be an array of instances or their primary keys |
| [options] | Object | Options passed to getAssociations |
Count everything currently associated with this, using an optional where clause.
Params:
This document is automatically generated based on source code comments. Please do not edit it directly, as your changes will be ignored. Please write on , open an issue or a create a pull request if you feel something can be improved. For help on how to write source code documentation see JSDoc and
